[AJ] Réecriture de la documentation

* simplifications diverses
  * corrections diverses
  * suppression de chapitres inutiles
This commit is contained in:
Olivier DOSSMANN 2012-02-29 19:02:12 +01:00
parent b68d64fd2d
commit bc172c1d27
2 changed files with 19 additions and 73 deletions

84
LISMOI
View File

@ -329,84 +329,30 @@ Configuration avancée :
la page HTML finale la page HTML finale
- enqueue : adresse exacte du fichier contenant le code HTML de l'enqueue de - enqueue : adresse exacte du fichier contenant le code HTML de l'enqueue de
la page HTML finale la page HTML finale
- contenu_fin : adresse exacte du fichier contenant le code final du contenu.
- contenu_fin = $(COMPOSANTS)/contenu_fin.html C'est utile pour la génération des catégories.
- contenu = categories.html - contenu : nom du fichier temporaire dans lequel sera écrit le code HTML du
- categ_deb = categ_deb.html contenu.
- categ_fin = categ_fin.html - categ_deb : code HTML du début d'une catégorie
- elem = element.html - categ_fin : code HTML de la fin d'une catégorie
- DEFAUT_IMG_ADDR = $(IMAGES)/$(DEFAUT_IMG) - elem : code HTML d'un élément
- DEFAUT_IMG_ADDR : adresse exacte de l'image par défaut utilisée si jamais
================================== aucune image n'est trouvée pour un élément donné.
INDEX_ADDR : adresse exacte du fichier final (page web).
CSS_SANS_MENU : nom de la feuille de style à utiliser quand la page est générée
sans menu. À noter que le fichier doit se trouver dans le dossier 'style'.
CSS_AVEC_MENU : nom de la feuille de style à utiliser quand la page est générée
avec un menu. À noter que le fichier doit se trouver dans le dossier
'style'.
CSS_NOM : nom de la feuille de style dans le résultat final
COMPOSANTS : nom du dossier contenant l'ensemble des composants. Cf Chapitre
sur les composants 'Les composants'.
MENU_ADDR : Adresse exacte du fichier contenant le menu de la future page
PorteAil.
INTRO_ADDR : Adresse exacte du fichier d'introduction de la future page
PorteAil.
Quelques autres éléments sont modifiables : les composants. Les valeurs
attachées à ces composants sont les suivantes :
- entete : fichier entete.html
- enqueue : fichier enqueue.html
- contenu_fin : fichier contenu_fin.html
- contenu : fichier temporaire possédant le contenu à insérer dans la page
- CATEGORIES : désigne le dossier dans lequel se trouve l'ensemble des
descriptions des catégories et des éléments se trouvant à l'intérieur de
chacune d'elle
- CATEGORIES_EXT : extension des fichiers contenus dans le dossier CATEGORIES
(précédemment renseigné) qui contiendra la description de base de chacune
des catégories et de ses éléments. Cf. Chapitre "Le dossier 'categ'"
- IMAGES : dossier contenant quelques images pour les éléments de chaque
catégorie. Toutes les images ne seront pas utilisées
- IMAGES_CIBLE : dossier dans lequel seront mises les images choisies dans
chacune des catégories (fichiers décrivant les catégories)
- DEFAUT_IMG : image par défaut utilisée si aucune autre image n'est
trouvée. Se trouve par défaut dans le dossier IMAGES (dossier 'img')
- DEFAUT_IMG_ADDR : adresse exacte du fichier image par défaut (Cf.
DEFAUT_IMG ci-avant pour de plus amples renseignements)
- categ_deb : nom du fichier contenant le code HTML d'un début de catégorie.
Le fichier doit se trouver dans le dossier renseigné par la variable
'composants'.
- categ_fin : nom du fichier contenant le code HTML d'une fin de catégorie.
Le fichier doit se trouver dans le dossier renseigné par la variable
'composants'.
- elem : nom du fichier contenant le code HTML d'un élément. Le fichier doit
se trouver dans le dossier renseigné par la variable 'composants'
- CSS : dossier dans lequel se trouve les feuilles de styles.
- CSS_AVEC_MENU_ADDR : adresse exacte du fichier contenant la feuille de style
ajoutant le menu
- CSS_SANS_MENU_ADDR : adresse exacte du fichier contenant la feuille de style
sans le menu
- STYLE_ADDR : adresse exacte de la feuille de style choisie par l'utilisateur.
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'.
#--[[ Les composants ]]--# #--[[ Les composants ]]--#
Les composants sont les éléments qui permettent de composer la page. Les composants sont les éléments qui permettent de composer la page HTML
À cet effet une page a été scindés en les éléments suivants : finale.
- entete.html : contient le début de notre page HTML À cet effet la page a été scindés en plusieurs éléments :
- entete.html : contient le début de notre page finale
- categ_deb.html : contient le début d'une catégorie - 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 - categ_fin.html : contient la fin d'une catégorie
- contenu_fin.html : contient la fin du corps de la page - contenu_fin.html : contient la fin du corps de la page
- enqueue.html : contient le pied de page - 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
@ -458,7 +404,7 @@ Déposez donc ici vos feuille de style et changez la variable 'CSS_AVEC_MENU'
Le dossier 'img' contient, dans la version 0.1, l'ensemble des images Le dossier 'img' contient, dans 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 voudriez utiliser. Déposez-y les images que vous allez utiliser.
### SOURCES ### ### SOURCES ###

8
TACHES
View File

@ -29,10 +29,6 @@ DESTDIR
- favicon.ico ? - favicon.ico ?
- Simplifier le fichier LISMOI
- ne donner que quelques lignes simples pour lancer le programme : installer, configurer, lancer !
- supprimer les chapitres inutiles
>>> Pour la v0.2 : >>> Pour la v0.2 :
- Transformer le fichier GNUmakefile en makefile pour bmake - Transformer le fichier GNUmakefile en makefile pour bmake
- changer les sed -i en "sed -e 's/chaine/autrechaine/g' > file.new && mv file.new file" (avec ou sans -e, c'est selon) - changer les sed -i en "sed -e 's/chaine/autrechaine/g' > file.new && mv file.new file" (avec ou sans -e, c'est selon)
@ -124,3 +120,7 @@ des éléments
- Supprimer les descriptions des logos pour un meilleur affichage (Cf. elinks par exemple pour une démonstration verbeuse) : les ajouter dans le CSS. Alt = rien du tout, et title = nom donné. - Supprimer les descriptions des logos pour un meilleur affichage (Cf. elinks par exemple pour une démonstration verbeuse) : les ajouter dans le CSS. Alt = rien du tout, et title = nom donné.
- Meilleur affichage dans les navigateurs textes (seulement les alt des images à modifier) - Meilleur affichage dans les navigateurs textes (seulement les alt des images à modifier)
- ajouter une extension aux fichiers images copiées - ajouter une extension aux fichiers images copiées
- Simplifier le fichier LISMOI
- ne donner que quelques lignes simples pour lancer le programme : installer, configurer, lancer !
- supprimer les chapitres inutiles