Documentations

README_theme.md

+# Configuration du thème et des composants
+### Comment ça marche ?
+
+#### Thème de base
+Nous utilisons le thème <strong>*Mint*</strong> qui reprend les composants <strong>*discourse-search-banner*</strong> et <strong>*Showcased Categories*</strong>.
+Nous avons apporté quelques modifications au thème <strong>*Mint*</strong>, afin d'en retirer des formes de décoration et le <strong>*discourse-search-banner*</strong>, ainsi qu'y mettre nos tons colorimétriques et certaines modifications liées aux composants.  
+
+<strong>Trois composants sont utilisés dans notre thème principal :</strong>
+
+#### Bannière "How to begin ?"
+D'après le composant <strong>*Versatile Banner*</strong>, nous récupérons les images d'après un url dans un groupe privée, accessible uniquement par l'admin *(pour plus d'info., voir ce lien https://meta.discourse.org/t/upload-image-in-discourse/141504/4)*.
+- Doc : https://meta.discourse.org/t/versatile-banner/109133
+- Dépôt : https://github.com/tshenry/discourse-versatile-banner.git
+##### Configuration
+- Possibilité d'afficher cette fonctionnalité à tout le monde ou à un type d'utilisateur : membres, inconnus.
+- Afficher la bannière sur les appareils mobiles, ordinateurs.
+- Afficher la bannière sur la page d'accueil.
+- Modification des images, des titres, sous-titres et textes, ainsi que du nombre de boxe (4 max). 
+- Choix des pages où apparaîtra la bannière.
+- Autoriser les utilisateurs à masquer la bannière.
+- Mettre un fond derrière les images.
+- Changer les couleurs du texte. 
+
+##### Notre configuration de base :
+La bannière est inclue dans le thème.
+La bannière s'affiche pour tout le monde et il est possible de la masquer mais pas de l'enlever.
+Elle apparaît sur les pages : 
+/latest
+/categories
+/new
+/unread
+/top*
+/tag/*
+/tags/*
+/c/*
+/t/*
+
+Il n'y a pas de fond ni d'image de fond, il est néanmoins possible d'en ajouter.
+
+Ensuite on ajoute le contenu de la bannière : texte, images dans chaque colonnes.
+
+Afin d'ajouter une image dans la bannière, il faut récupérer son lien URL. Pour se faire, on créer un post avec une image dans la catégorie staff (privée). Le post ainsi créée, on affiche l'image et on y fait un clic droit pour "copier le lien de l'image". Puis, coller ce lien dans la page configuration du composant, section <strong>*Column Icons*</strong>.
+Voir la page suivante : https://meta.discourse.org/t/upload-image-in-discourse/141504
+
+---
+#### Categories boxes
+Nous partons du html du composant <strong>*Categories Layout Override*</strong>, et utilisons le scss d'un autre lien.
+- Doc Categories layout override : https://meta.discourse.org/t/categories-layout-override/131098
+- Dépôt : https://github.com/tshenry/discourse-categories-layout-override
+
+- Doc et code scss : https://meta.discourse.org/t/how-to-change-categories-style/78067/14
+
+Note : Des modifications ont été réalisé dans le scss.
+
+##### Notre configuration de base :
+Les titres et sous-titres ne sont pas affichés grace à l'option category-boxe, et nous gardons uniquement les images et les titres des topics. 
+
+---
+#### Category post
+Le composant <strong>*Showcased Categories*</strong> s'adapte d'office au thème général du forum. 
+- Doc : https://meta.discourse.org/t/showcased-categories-theme-component/173524
+- Dépôt : https://github.com/discourse/discourse-showcased-categories.git
+##### Configuration
+Définir le thème de ce que constitura les deux boîtes. On défini la taille maximum du contenu des boîtes et de son contenu : Latest et Top.
+
+---
+
+#### Configuration générale après installation du thème
+Par défaut, des couleurs ont été appliqué mais vous pouvez les modifier votre palette de couleurs dans <strong>Customize / Colors.</strong> Pour faire valider le thème, celui-ci doit être votre <strong>thème par défaut.</strong> Dans la section <strong>*Included Components*</strong>, vous pouvez cliquer sur <strong>*Add all*</strong> ou bien n'en mettre que certains.