Ginkgo 6

Documentation

- Sommaire

Bienvenue dans l'interface Ginkgo 6 - http://www.ginkgo-cms.com

Naviguez dans la documentation grâce au menu latéral, ainsi qu'aux boutons de navigation sur le pied de page

 

Gingko 6 CMS est sous licence GNU GPL 3 & CECILL 2.1 -


- Découvrir Ginkgo

Objectifs de Ginkgo

  • Administrez votre site en toute autonomie.
  • Publiez vos textes, images, documents en toute simplicité.
  • Agissez sur le graphisme de votre site.
  • Créez vos formulaires de contact.
  • Gérez la popularité de votre site Internet.

Fonctionnalités du système de publication Ginkgo CMS

  • Une édition directement en ligne
  • Une mise en forme des articles grâce à une barre d’outils typique des traitements de texte.
  • Un nombre de pages, de rubriques et de photos illimité.
  • Une bannière personnalisée contenant votre logo, une illustration, un titre et un texte d’accroche.
  • Choix des couleurs de fond et des textes de votre navigation.
  • Choix de l’ergonomie de votre site (emplacement de la navigation).
  • En-tête et pied de page personnalisés.
  • Publication de votre site chez « l’hébergeur » de votre choix.
  • ...


- Installer Ginkgo

L'installation de Ginkgo 6 ne fonctionne que sur un environnement vierge,
Pour migrer depuis Ginkgo 5, reportez vous à la Migration

Pour installer Ginkgo 6, commencez par accédez à votre FTP. Pour ce faire, nous vous conseillons Filezilla

  • Copiez l'intégralité des fichiers de Ginkgo 6 à la racine de votre FTP, ou dans un sous-répertoire
  • A l'aide de votre navigateur, rendez-vous sur votre site
  • Suivez l'assistant d'installation :
    • L'adresse complète de votre site, sous-répertoire compris
    • Les paramètres MySQL
    • Les paramètres du site
      • Votre nom d'utilisateur doit être > à 4 caractères
      • Votre mot de passe doit être > à 6 caractères
      • Le contenu de démonstration ajoutera quelques articles d'exemple à votre site
      • Les paramètres avancés sont, par défaut, adaptés à la configuration de votre site
    • Vérifiez votre saisie, puis validez l'installation
    • Cela peut prendre quelques minutes, en cas d'erreur, reportez vous à la vérification de saisie
  • Votre site Ginkgo 6 est désormais prêt à être utilisé en production

- Depuis Ginkgo 5

La migration depuis Ginkgo 5 se déroule simplement, en quelques étapes :

  • Commencez par accéder au FTP de Ginkgo 5
    • Créez un dossier nommé "_old" à la racine de votre installation
    • Déplacez l'intégralité des fichiers de Ginkgo 5 dans ce dossier
  • Copiez ensuite les fichiers de Ginkgo 6 à la racine de votre installation
  • A l'aide de votre navigateur, rendez-vous sur votre site
  • Suivez l'assistant, en prenant soin de vérifier chaque point
  • Votre site est désormais prêt à l'emploi, avec la dernière version de Ginkgo !

Votre nom d'utilisateur ainsi que votre mot de passe sont inchangés
Attention tout de même, vos anciens fichiers de sauvegarde sont incompatibles avec Ginkgo 6

Ginkgo 6 est plus sécurisé que Ginkgo 5,
L'interface d'administration à été intégrale revue pour être plus accessible, plus ouverte


- L'Utilisateur

Ginkgo 6 possède deux types d'utilisateurs,

  • Les Utilisateurs connectés, avec un mot de passe
  • Les Visiteurs

Les Visiteurs ont accès à la partie publique de votre site, ils consultent les rubriques, et les textes, et peuvent vous contacter via les formulaires

Les Utilisateurs quant à eux peuvent écrire des textes, ajouter des documents, modifier le graphisme, ... par le biais de l'Administration

Ginkgo 6 fonctionne avec un système de droit illimité pour les Utilisateurs, chacun d'entre-eux pouvant modifier l'intégralité du site.

Par sécurité, les Utilisateurs sont automatiquement déconnecté après une durée définie à l'installation (2h par défaut.), cette durée est affichée en bas de chaque page de l'administration


- L'Administration

L'administration de Ginkgo 6 est accessible à l'adresse de votre site /administration
Exemple : http://ginkgo-cms.com/administration

Dans cette dernière, les utilisateurs peuvent modifier le site

  • Textes
    • L'ajout et la suppression de Rubriques
    • La modification des Textes
  • Documents
    • L'envoi de documents en tous types (PDF, Word, Excel, ...)
    • La suppression de ces derniers
  • Images
    • L'envoi d'images (PNG, JPG, GIF)
    • La suppression de ces dernières
  • Maintenance
    • La création, suppression, modification d'Utilisateurs
    • L'import de Sauvegarde du site
    • La Sauvegarde du Graphisme
    • La Sauvegarde des Textes
  • Graphisme
    • La modification des images et couleurs du site publique
    • La modification des mots-clefs, et du titre du site
  • Statistiques
    • La visualisation des statistiques, par nombre de Vues
    • L'export d'un graphisme contenant ces statistiques
    • Les mots clefs utilisés
    • La comptabilisation des Robots
  • Greffons
    • Pour les utilisateurs avancés uniquement

- Textes & Rubriques

Les Textes sont l'équivalent des Articles pour Ginkgo
Chaque texte est stocké dans une Rubrique

Les rubriques sont ce que vos visiteurs verront dans le menu de votre site, là où les textes seront le contenu de ces dernières.

L'édition des textes se fait grâce à un éditeur TinyMCE modifié, vous permettant d'inscrire aisément vos documents et vos images.


- Images & Documents

Vos documents (PDF, DOC, ODT, ...) et images (PNG, JPG, GIF) sont stockés sur votre site dans le dossier public/images|public/documents.

L'intégration de ceux-ci se font grâce à l'éditeur de textes. Dans le cas où après l'envoi d'une image ou d'un document, celui-ci n'apparaitrait pas dans la liste, veuillez actualiser la page.

Le nommage de vos images et documents est automatique, afin d'éviter les doublons. Cliquez sur une image pour en avoir un plus grand aperçu, et pour voir quel nom cette image possède.


- Créer un Utilisateur

Via le menu maintenance, vous pouvez créer, éditer, supprimer un utilisateur de votre site Ginkgo.

Le champs d'e-mail est facultatif, il permet uniquement de réinitialiser votre mot de passe en cas d'oubli.


- Sauvegarde & Restauration

Via le menu maintenance, Ginkgo propose une sauvegarde de votre site ou de votre graphisme.

Les sauvegardes du site (.ggc) permettent de restaurer les Textes, le Graphisme, les Paramètres, et Utilisateurs du site.
Elles sont restaurables uniquement sur un site Ginkgo configuré avec la même clef d'encryptage.

Les sauvegardes du graphisme (.ggg) quant à elles ne possèdent que les paramètres graphiques (Couleurs, positions, ...), elles sont utilisables sur n'importe quelle configuration Ginkgo


- Le Graphisme

Le Graphisme et les paramètres tels que le titre du site, ou les mots clefs sont modifiables par le biais du menu Graphique.

Par défaut, Ginkgo propose un nombre limité de polices, de couleurs, et de styles. Utilisateurs avancés, référez-vous aux Greffons pour en apprendre plus sur la modification des options


- Les Statistiques

Ginkgo 6 bénéficie de statistique visiteurs par nombre de vues.

Concrètement, celà signifit que chaque visiteur passant sur votre site ajoutera "1 vue" au compteur de chaque rubrique qu'il aura consulté.

Si un visiteur consulte deux fois la même rubrique lors de sa visite, le compteur affichera "2 vues" pour la rubrique en question.

Notez que le nombre de Vues est relatif au paramètres du site, lorsque vous paramétrez 24h entre chaque journaux (Soit 1 jour), si au 1er janvier vous êtes à 0 visites, qu'entre le 1er et le 2 vous avez eu 50 vues, le journal du 2e janvier affichera 50, il faut donc lire : 50 vues entre le 1er et le 2 janvier.

Vous pouvez afficher les détails des journaux, en dessous du graphique.
Les détails permettent de visualiser les vues par rubriques de l'ensemble des journaux archivés, ainsi que le Flux de ces dernières

Outre le nombre de Vues, Ginkgo répertorie la provenance des visiteurs, lorsqu'un visiteur est venu en lien direct, il affichera le nom de votre site.

Les mots clefs des recherches visiteurs sur les moteurs de recherche sont compatibles avec "Google", "Yahoo", "Bing", "Baidu", "Alltheweb", "Aol" ainsi que "Ask".


- Mode expert

En ajoutant "?dev" à la fin de l'URL de votre site ou de l'administration, vous obtenez des informations et paramètres supplémentaires

Sur l'Administration, vous pouvez même gérer les Greffons de votre site
Ces derniers permettent de modifier le CSS, les JS, et d'outrepasser les paramètres du site

Sur la partie publique, si vous êtes connecté, vous pouvez effectuer une checklist de votre site


- Les Greffons

Les Greffons sont des morceaux de code qui viennent se greffer à votre site
Vous devez être en mode développeur pour accéder aux Greffons.

Ils peuvent avoir différentes utilités, modifier le graphique, changer le fonctionnement de certaines fonctions, outrepasser certains points...

L'exemple basique de Greffon est celui d'un ajout d'un bouton Twitter sur chacun de vos articles, ou encore celui qui permet l'appel des CSS/JS.

L'utilisation de ces derniers évite aux développeurs d'avoir à fouiller dans le code de Ginkgo pour apporter leurs améliorations.

Chaque greffon possède plusieurs niveaux de paramètres :

  • Le Nom
    • Identifiant unique, en minuscule, de 2 à 10 caractères, sans accents, ni caractères spéciaux.
  • La Position
    • Le Greffon peut être appellé :
    • default : En haut de toutes les pages, au dessus du HTML
    • head : Entre les balises <head>, après l'appel des CSS
    • footer : Au pied des pages, après l'appel des Javascripts
    • inherit : En héritage, après tout le code
  • La Page
    • Le Greffon peut être appellé :
    • * : Sur toutes les pages
    • index : Uniquement dans les rubriques
    • envoi_email : Au sein du script d'envoi d'emails
    • imprime : Sur la page d'impression
    • sitemap : Sur le sitemap du site
  • La Description
    • Sans caractères spéciaux, sans limite de caractères
  • Le Code
    • Est stocké dans un fichier, nommé "call.php"
    • Ce fichier est placé dans un dossier homonyme au nom du Greffon (./sys/private/plugins/)

La page de gestion des Greffons permet aussi la gestion des Google Fonts appelés par le CSS
Ceux-ci devant être séparés par un "|"
Par défaut, Ginkgo appelle "Metrophobic,Tangerine,Dancing+Script,Sunshiney,Chewy,Geo,Lobster,Yanone+Kaffeesatz,Raleway"


- Créer & Modifier un Greffon

La création, et la modification de Greffon passe par le mode développeur.

Vous pouvez installer des greffons via le dépôt officiel de Ginkgo CMS, ces derniers étant garantis compatibles avec les sites Ginkgo

L'éditeur intégré n'étant des plus sophistiqué, nous vous conseillons de rédiger votre script sur un éditeur plus adapté, tel que Notepad++, puis de copier-coller votre code

Une fois un Greffon créé, vous ne pourrez plus modifier les pages/position/nom/description du plugin en question

Ginkgo utilise des variables pour certains paramètres, des fonctions étant appellés pour les Rubriques et Textes

  • out_oneach_rub() affichera le return une fois par page
  • out_oneach_textes() affichera le return après chaque texte

Ces fonctions sont uniques, veillez à n'avoir qu'un seul script les appellant, dans le doute, utilisez function_exists()

Exemple de Greffon :

Ajouter un bouton Twitter à la fin de chaque article
<?php //Vérification & Création de la fonction
	if(!function_exists('out_on_each_textes')) {
	function out_oneach_textes(){
		return ' <a href="https://twitter.com/share" class="twitter-share-button"
		data-lang="fr" data-hashtags="ginkgo6">Tweeter</a> <script>!f
		unction(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^
		http:/.test(d.location)?\'http\':\'h
		ttps\';if(!d.getElementById(id)){js=d.createElement(s);js.id=
		id;js.src=p+\'://platform.twitter.c
		om/widgets.js\';fjs.parentNode.insertBefore(js,fjs);}}(document
		, \'script\', \'twitter-wjs\');
		</script>';
	}
	}
?>
Modifier le contenu et le style du footer
<style>
.main#top {
	margin-bottom:75px; //75px pour footer en fixed
}
.footer {
	position:fixed; //Position
	bottom:0;
	left:50%; //Centrage
	margin-left:-375px;
	width:750px;
	text-align:center; //Police
	font-size:10pt;
}
</style>
<script> //Réécriture du contenu
	setTimeout(function(){$('.footer').html('Ce footer est géré par un greffon !');},200);
</script>


- Contribuer à Ginkgo

Que vous soyez codeur, graphiste, un vilain pirate, ou encore que vous n'y connaissiez rien, mais que vous avez des idées...

Toute participation à la progression de Ginkgo est la bienvenue !

N'hésitez pas à nous contacter via ginkgo-cms.com


- Licence Ginkgo

Ginkgo 6 est sous licence GNU GPL v3 pour l'internationnal, et sous licence CECILL 2.1 pour la France

Ces licences font de Ginkgo un environnement libre et OpenSource, mais imposent que toute modification ou altération réalisée soit écrite sous la même licence

L'équipe de développement se réserve le droit de maintenir ou non, de modifier, ... Ginkgo CMS à tout moment, sans préavis.

Réferez-vous à la partie Contribuer si vous souhaitez proposer vos améliorations


- Dépendances

Ginkgo profite de Jquery (Licence MIT) & de TinyMCE (Licence GNU LGPL 2.1)

Gingko a été créé par Benjamin Arnaudet. Version 6 en collaboration avec Jean-Baptiste Pasquier.


- Partagez

Partager sur Facebook

Partager sur Google+


- Merci d'avoir lu cette documentation

Nous esperons que vous passerez un bon moment aux cotés de Ginkgo