Général

Description

Cet ensemble de bibliothèque est conçu afin de pouvoir ajouter quelques fonctions utiles lors de la création d'un site web. Ces fonctions ont été faites de manière à pouvoir être utiliser le plus simplement possible.

Historique

01/08/2008

05/08/2008

Core

common.js

Description

Cette bibliothèque fournit quelques fonctions basiques nécessaires au bon fonctionnement du tout. Elle n'est pas optionnelle.

Utilisation

Dans le Header de votre fichier HTML, ajoutez :

<script type="text/javascript" src="js/common.js"></script>

prepare.js

Description

Cette bibliothèque associe les différentes fonctions au différents éléments. Il créé il fonction load qui est associé au Body. Ce que fait Prepare :

Utilisation

Dans le Header de votre fichier HTML, ajoutez :

<script type="text/javascript" src="js/prepare.js"></script>

prepare.js doit toujours etre inclus en dernier

Inclusion nécessaire

Modules

index.js

Description

Cette bibliotheque créé dans le div dont l'id est "index_index" un index fabriqué à partir de la succession de H1..H7 contenu dans le div dont l'id est "index_content". Des ancres locales sont créées dans les h1..h7 afin de pouvoir aller sur un titre en cliquant sur un element de l'index. Il n'est pas nécessaire de numéroter les titres, cela est fait lors de l'indexation.

Utilisation

Dans le Header de votre fichier HTML, ajoutez :

<script type="text/javascript" src="js/index.js"></script>

Puis créez dans un div nommé "index_content", une succession de h1..h7 et créez un div nommé "index_index" vide. Lors du chargement de la page, l'index se créera automatiquement.

Exemple

Inclusion nécessaire

Style

Il est tout à fait possible de modifier les styles des éléments "index_content" et "index_index". De plus, dans l'index, les numéros sont caractérisés par la classe "index_numero" et les titres par "index_texte". Ces deux éléments sont des spans. Chaque item du menu est represente par un LI qui contient la classe "index_level_X" ou X est le level de l'item. Par exemple pour un h3, le level sera 3.

input.js

Description

Cette bibliothèque fournie quelques fonctions afin d'affiner le comportement des input. Pour l'instant, elle fournit 3 fonctions qui peuvent etre associer a des input de type "text".

Utilisation

Dans le Header de votre fichier HTML, ajoutez :

<script type="text/javascript" src="js/input.js"></script>

Ensuite, il ne reste plus qu'a ajouter la classe qui correspond a la fonction désirée à votre input.

Il est possible d'utiliser autoFill conjointement avec autoClear ou autoSelect

Exemple

Inclusion nécessaire

Style

Ces trois classes sont tout à fait utilisables pour définir la forme qu'aura chacun des inputs.

highlight.js

Description

Ce fichier contient les fonctions necessaires au surlignage de terme dans les elements P et BLOCKQUOTE.

Utilisation

Dans le Header de votre fichier HTML, ajoutez :

<script type="text/javascript" src="js/highlight.js"></script>

Le terme recherché est precisé dans un input repondant à l'id "highlight_text". Il faut donc créer cet input. Il faut ensuite créer un bouton qui aura comme id "highlight_button". C'est lors de l'appui sur ce bouton que se declenchera la mise en surbrillance. Il faut aussi definir la classe css "highlight_highlight" qui sera appliqué au texte trouve.

Exemple

Inclusion nécessaire

Style

Comme vu plus haut, il est necessaire de definir la classe "highlight_highlight". Si cela n'est pas fait, aucune erreur ne ressortira par contre, le surlignage ne sera pas visible.

hint.js

Description

Cette bibliotheque permet d'afficher le titre des liens dans un div.

Utilisation

Dans le Header de votre fichier HTML, ajoutez :

<script type="text/javascript" src="js/hint.js"></script>

Afin de mettre en place les hint, il suffit de créer un element ayant pour id "hint_display".

Exemple

Inclusion nécessaire

Style

Rien de particulier

editor.js

Description

Cette bibliotheque permet l'edition de paragraphe (balise P)

Utilisation

Dans le Header de votre fichier HTML, ajoutez :

<script type="text/javascript" src="js/editor.js"></script>

Afin de rendre un paragraphe (balise P) éditable, affecter lui le style "editor_editor". Il faut ensuite définir la fonction javascript "editor_save" qui doit avoir la structure suivante :

function editor_save( savedElement ) {}

savedElement est l'élément qui a été modifié

Il est possible de configurer le script en définissant certaines variables en javascript

Exemple

Inclusion nécessaire

Style

il est possible d'agir sur le style de diverses choses en :

La toolbar
Le formulaire d'édition