[UP] Update documentation
This commit is contained in:
parent
1abc0c8e2b
commit
1fbbb2ebb6
96
README.md
96
README.md
@ -128,12 +128,12 @@ Ce fichier apparaît depuis la version 0.1.1. Il vous permettra de changer,
|
|||||||
par exemple, le titre de votre page PorteAil. Ceci se fait via la
|
par exemple, le titre de votre page PorteAil. Ceci se fait via la
|
||||||
ligne suivante :
|
ligne suivante :
|
||||||
|
|
||||||
TITRE=
|
TITLE=
|
||||||
|
|
||||||
Par exemple pour afficher "Mon super site" sur la page PorteAil, modifiez ceci
|
Par exemple pour afficher "Mon super site" sur la page PorteAil, modifiez ceci
|
||||||
dans le fichier configrc :
|
dans le fichier configrc :
|
||||||
|
|
||||||
TITRE = Mon super site
|
TITLE = Mon super site
|
||||||
|
|
||||||
D'autres éléments peuvent être modifiés afin de personnaliser le résultat de
|
D'autres éléments peuvent être modifiés afin de personnaliser le résultat de
|
||||||
PorteAil. Pour de plus amples renseignements à ce sujet, je vous invite à lire
|
PorteAil. Pour de plus amples renseignements à ce sujet, je vous invite à lire
|
||||||
@ -270,6 +270,13 @@ script et modifiez les valeurs suivantes :
|
|||||||
à copier
|
à copier
|
||||||
- DESTDIR : contient l'adresse exacte où copier les fichiers (la destination).
|
- DESTDIR : contient l'adresse exacte où copier les fichiers (la destination).
|
||||||
|
|
||||||
|
NB : Il est possible d'avoir le même fonctionnement en utilisant la commande
|
||||||
|
suivante :
|
||||||
|
|
||||||
|
make install
|
||||||
|
|
||||||
|
Et tout sera copié de DESTDIR à SRCDIR.
|
||||||
|
|
||||||
## Pour aller plus loin
|
## Pour aller plus loin
|
||||||
|
|
||||||
Tous les éléments expliqués ci-avant ne seront que partiellement ou pas du
|
Tous les éléments expliqués ci-avant ne seront que partiellement ou pas du
|
||||||
@ -321,51 +328,36 @@ plus grand sur la page de résultat.
|
|||||||
|
|
||||||
Configuration basique :
|
Configuration basique :
|
||||||
|
|
||||||
- TITRE : Cf. chapitre **Fonctionnement basique**
|
- TITLE : Cf. chapitre **Fonctionnement basique**
|
||||||
- STYLE : nom de la feuille de style qui ajoutera des couleurs à PorteAil
|
- STYLE : nom de la feuille de style qui ajoutera des couleurs à PorteAil
|
||||||
(seconde feuille de style en somme). Redéfinir l'ensemble des classes
|
(seconde feuille de style en somme). Redéfinir l'ensemble des classes
|
||||||
CSS de ce fichier vous permettra de reconfigurer toute l'apparence de
|
CSS de ce fichier vous permettra de reconfigurer toute l'apparence de
|
||||||
PorteAil.
|
PorteAil.
|
||||||
- MENU : Cf. chapitre **Fonctionnement basique**
|
- MENU : Cf. chapitre **Fonctionnement basique**
|
||||||
- INTRO : Cf. chapitre **Fonctionnement basique**
|
- INTRO : Cf. chapitre **Fonctionnement basique**
|
||||||
- CIBLE : nom du dossier dans lequel sera généré le portail web.
|
- DESTINATION : nom du dossier dans lequel sera généré le portail web.
|
||||||
|
|
||||||
Configuration avancée :
|
Configuration avancée :
|
||||||
|
|
||||||
- ACCUEIL : Titre de la page tel qu'il s'affichera sur un navigateur
|
- HOMEPAGE : Titre de la page tel qu'il s'affichera sur un navigateur
|
||||||
- GEN_CATEGORIES : script bash lancé au moment de la création des
|
|
||||||
catégories. C'est ce script qui génère les catégories pour la page
|
|
||||||
finale.
|
|
||||||
- INDEX : nom du fichier final. Par exemple *index.html*
|
|
||||||
- CATEGORIES_EXT : extension des fichiers qui seront lus pour générer
|
- CATEGORIES_EXT : extension des fichiers qui seront lus pour générer
|
||||||
les catégories
|
les catégories
|
||||||
- DEFAUT_IMG : nom de l'image - contenue par défaut dans le dossier img -
|
- DEFAUT_IMG : nom de l'image - contenue par défaut dans le dossier img -
|
||||||
par défaut pour un élément qui n'a pas d'image ou n'en a pas trouvé.
|
par défaut pour un élément qui n'a pas d'image ou n'en a pas trouvé.
|
||||||
- ELEMENT : nom du fichier contenant le code HTML d'un élément. Se trouve
|
- TEMPLATE_ELEMENT : nom du fichier contenant le code HTML d'un élément.
|
||||||
par défaut dans le dossier *COMPOSANTS*.
|
Se trouve par défaut dans le dossier *COMPONENTS*.
|
||||||
- CONTENU : nom du fichier contenu le résultat de la génération des
|
- TEMPLATE_INDEX : nom du fichier contenant le code HTML de la page finale.
|
||||||
catégories.
|
Se trouve par défaut dans le dossier *COMPONENTS*.
|
||||||
- ENTETE_CAT : nom du fichier contenant le code HTML du début d'une
|
- TEMPLATE_CATEG : nom du fichier contenant le code HTML d'une catégorie.
|
||||||
catégorie. Se trouve par défaut dans le dossier *COMPOSANT*.
|
Se trouve par défaut dans le dossier *COMPONENTS*.
|
||||||
- ENQUEUE_CAT : nom du fichier contenant le code HTML de la fin d'une
|
- COMPONENTS : dossier contenant les éléments qui constitueront la page
|
||||||
catégorie. Se trouve par défaut dans le dossier *COMPOSANT*.
|
|
||||||
- POST_CONTENU : nom du fichier contenant le code HTML à utiliser après
|
|
||||||
le contenu des catégories. Se trouve par défaut dans le dossier *COMPOSANT*.
|
|
||||||
- ENTETE : nom du fichier contenant le code HTML à utiliser en début de la
|
|
||||||
page finale.
|
|
||||||
- ENQUEUE = nom du fichier contenant le code HTML à utiliser en fin de la
|
|
||||||
page finale
|
|
||||||
- COMPOSANTS : dossier contenant les éléments qui constitueront la page
|
|
||||||
finale
|
finale
|
||||||
- CATEGORIES : dossier contenant les fichiers sources des catégories.
|
- CATEGORIES : dossier contenant les fichiers sources des catégories.
|
||||||
- IMAGES : dossier par défaut contenant les images pour les éléments.
|
- IMAGES : dossier par défaut contenant les images pour les éléments.
|
||||||
- CSS : dossier par défaut des feuilles de style
|
- CSS : dossier par défaut des feuilles de style
|
||||||
- IMAGES_CIBLE : nom du dossier qui contiendra les images utilisées par la
|
- IMAGES_DESTINATION : nom du dossier qui contiendra les images utilisées par la
|
||||||
page finale
|
page finale
|
||||||
- CSS_SANS_MENU : nom du fichier CSS qui s'utilise lorsque la page n'a pas
|
- CSS_NAME : nom du fichier CSS final
|
||||||
de menu
|
|
||||||
- CSS_AVEC_MENU : idem que *CSS_SANS_MENU*, mais pour une page ayant un menu
|
|
||||||
- CSS_NOM : nom du fichier CSS final
|
|
||||||
|
|
||||||
Pour plus de renseignements, veuillez vous référer au chapitre **Les
|
Pour plus de renseignements, veuillez vous référer au chapitre **Les
|
||||||
composants**.
|
composants**.
|
||||||
@ -376,12 +368,10 @@ Les composants sont les éléments qui permettent de composer la page HTML
|
|||||||
finale.
|
finale.
|
||||||
À cet effet la page a été scindés en plusieurs éléments :
|
À cet effet la page a été scindés en plusieurs éléments :
|
||||||
|
|
||||||
- entete.html : contient le début de notre page finale
|
- index.html : contient l'ensemble du HTML pour la page d'accueil.
|
||||||
- categ_deb.html : contient le début d'une catégorie
|
|
||||||
- element.html : contient l'ensemble du HTML pour UN élément donné
|
- element.html : contient l'ensemble du HTML pour UN élément donné
|
||||||
- categ_fin.html : contient la fin d'une catégorie
|
- categories.html : contient l'ensemble du HTML pour une catégorie donnée.
|
||||||
- contenu_fin.html : contient la fin du corps de la page
|
(sans les éléments)
|
||||||
- enqueue.html : contient le pied de la page finale
|
|
||||||
- introduction.html : contient du HTML pouvant être ajouté après le titre
|
- introduction.html : contient du HTML pouvant être ajouté après le titre
|
||||||
principal de la page
|
principal de la page
|
||||||
- menu.html : un menu à ajouter à notre page
|
- menu.html : un menu à ajouter à notre page
|
||||||
@ -389,49 +379,17 @@ principal de la page
|
|||||||
Pour personnaliser il suffit d'éditer chacun des fichiers afin d'en
|
Pour personnaliser il suffit d'éditer chacun des fichiers afin d'en
|
||||||
modifier le code source.
|
modifier le code source.
|
||||||
|
|
||||||
### La création des catégorie à l'aide de creation_categ.sh
|
|
||||||
|
|
||||||
Le fichier **creation_categ.sh** permet de générer le corps de la page.
|
|
||||||
À cet effet il va parcourir un dossier, générer les catégories une à une
|
|
||||||
et les éléments associés, puis il va tout déposer dans un fichier HTML
|
|
||||||
prévu à cet effet.
|
|
||||||
|
|
||||||
Le script fonctionne avec un certain nombre de paramètres parmi :
|
|
||||||
|
|
||||||
- dossier_cat : contient la source (dossier d'entrée) dans laquelle se trouve
|
|
||||||
les fichiers décrivant les catégories et les éléments associés.
|
|
||||||
- destination.html : contient la destination. C'est à dire le fichier dans
|
|
||||||
lequel se situera le corps, temporairement évidemment.
|
|
||||||
- extension : extension des fichiers décrivant les catégories et leurs
|
|
||||||
éléments associés
|
|
||||||
- dossier_composants : ce dossier réunit l'ensemble des composants de notre
|
|
||||||
page finale. Il est utile pour récupérer le fichier **element.html**,
|
|
||||||
disponible d'ailleurs dans la variable *elem*
|
|
||||||
- entete_cat.html : contenu HTML du début d'une catégorie
|
|
||||||
- enqueue_cat.html : contenu HTML qui marque la fin d'une catégorie
|
|
||||||
- element.html : contenu HTML qui contient UN élément
|
|
||||||
- dossier_img : dossier contenant les images dites *sources*
|
|
||||||
- destination_img : nom du dossier dans lequel seront stockées les images
|
|
||||||
finales
|
|
||||||
- image.png : nom du fichier par défaut utilisé lorsque les images ne sont pas
|
|
||||||
trouvées
|
|
||||||
- dossier_porteail : nom du dossier dans lequel sera mise la page PorteAil
|
|
||||||
|
|
||||||
Normalement, avec toutes ces données vous devriez pouvoir tester par vous
|
|
||||||
même le résultat du script et améliorer le rendu de vos pages.
|
|
||||||
|
|
||||||
### Le dossier style
|
### Le dossier style
|
||||||
|
|
||||||
Le dossier **style** est prévu pour contenir l'ensemble des feuilles de style
|
Le dossier **style** est prévu pour contenir l'ensemble des feuilles de style
|
||||||
disponible pour l'apparence de notre page PorteAil.
|
disponible pour l'apparence de notre page PorteAil.
|
||||||
|
|
||||||
Déposez donc ici vos feuille de style et changez la variable *CSS_AVEC_MENU*
|
Déposez donc ici vos feuille de style et changez la variable *STYLE* du
|
||||||
, *CSS_SANS_MENU* et *STYLE* du fichier **configrc** (Cf. Chapitre
|
fichier **configrc** (Cf. Chapitre **configrc**).
|
||||||
**configrc**).
|
|
||||||
|
|
||||||
### Le dossier img
|
### Le dossier img
|
||||||
|
|
||||||
Le dossier **img** contient, dans la version 0.1, l'ensemble des images
|
Le dossier **img** contient, depuis la version 0.1, l'ensemble des images
|
||||||
utilisées pour la page finale.
|
utilisées pour la page finale.
|
||||||
|
|
||||||
Déposez-y les images que vous allez utiliser.
|
Déposez-y les images que vous allez utiliser.
|
||||||
|
@ -39,6 +39,4 @@ DESTINATION = porteail
|
|||||||
#
|
#
|
||||||
###--[[ style ]]--##
|
###--[[ style ]]--##
|
||||||
#
|
#
|
||||||
#CSS_WITHOUT_MENU = sans_menu.css
|
|
||||||
#CSS_WITH_MENU = avec_menu.css
|
|
||||||
#CSS_NAME = defaut.css
|
#CSS_NAME = defaut.css
|
||||||
|
@ -34,11 +34,9 @@ TEMPLATE_CATEG = categories.html
|
|||||||
COMPONENTS = composants
|
COMPONENTS = composants
|
||||||
CATEGORIES = categ
|
CATEGORIES = categ
|
||||||
IMAGES = img
|
IMAGES = img
|
||||||
IMAGES_DESTIONATION = image
|
IMAGES_DESTINATION = image
|
||||||
CSS = style
|
CSS = style
|
||||||
|
|
||||||
##--[[ style ]]--##
|
##--[[ style ]]--##
|
||||||
|
|
||||||
CSS_WITHOUT_MENU = sans_menu.css
|
|
||||||
CSS_WITH_MENU = avec_menu.css
|
|
||||||
CSS_NAME = defaut.css
|
CSS_NAME = defaut.css
|
||||||
|
Loading…
Reference in New Issue
Block a user