Apache HTTP Server Version 1.3

Module mod_autoindex

Résumé

Un index sur un répertoire peut être obtenu à partir de deux sources :

• Un fichier écrit par l'utilisateur, appelé typiquement index.html. La directive DirectoryIndex définit quel est le nom usuel de ce fichier. Cet index est contrôlé dans le module mod_dir.
• Alternativement, une liste générée par le serveur. Les autres directives contrôlent le format de cette liste. Les directives AddIcon, AddIconByEncoding et AddIconByType définissent un ensemble d'icônes à afficher pour représenter les divers types de fichiers ; pour chaque fichier du répertoire, le premier icone dans la liste associée une définition correspondant à ce fichier est utilisée. Ces listes sont contrôlées par le module mod_autoindex.

Ces deux fonctions sont séparées et vous pouvez donc entièrement désactiver (ou remplacer) le mécanisme de génération automatique si vous le souhaitez.

Si l'option FancyIndexing est active, ou le mot-clef FancyIndexing est présent dans une directive IndexOptions, Les en-têtes de colonnes sont des liens qui permettent de déterminer l'ordre dans lequel le contenu est affiché. Lorsque vous sélectionnez une de ces en-têtes, la liste sera remise à jour, triée selon les valeurs de cette colonne. En cliquant plusieurs fois sur cette en-tête, vous commuterez entre un affichage par ordre croissant et décroissant (alphabétiquement parlant) de la liste.

Notez que lorsque l'affichage est trié par taille ("Size"), l'ordre est généré sur la base de la taille effective des fichiers, et non celle affichée - ainsi, un fichier de 1010 octets sera toujours listé avant un de 1011 octets (affichage croissant) bien que leur taille affichée soit "1K" pour les deux.

Directives

Directive : AddAlt

Définit le texte alternatif affiché pour un fichier, à la place de l'icône, dans le mode FancyIndexing. Fichier est une extension de fichier, un nom de fichier partiel, une expression utilisant des métacaractères ou le nom complet de fichiers. Chaîne doit être mentionnée entre guillemets ("). Ce texte alternatif est affiché si le client ne dispose pas de la capacité d'afficher des images, ou a désactivé le chargement d'images.

Directive : AddAltByEncoding

Définit le texte alternatif affiché pour un fichier, à la place de l'icône, dans le mode FancyIndexing. encodage-MIME est un encodage de contenu valide, tel que x-compress. Chaîne doit être mentionnée entre guillemets ("). Ce texte alternatif est affiché si le client ne dispose pas de la capacité d'afficher des images, ou a désactivé le chargement d'images.

Directive : AddAltByType

Définit le texte alternatif affiché pour un fichier, à la place de l'icône, dans le mode FancyIndexing. type-MIME est un type de contenu valide, tel que text/html. Chaîne doit être mentionnée entre guillemets ("). Ce texte alternatif est affiché si le client ne dispose pas de la capacité d'afficher des images, ou a désactivé le chargement d'images.

Directive : AddDescription

Définit la description à afficher pour un fichier, dans le mode FancyIndexing. Fichier est une extension de fichier, un nom partiel de fichier, une expression contenant des métacaractères, ou un nom complet de fichier. Chaîne doit être mentionnée entre guillemets ("). Exemple :

AddDescription "The planet Mars" /web/pics/mars.gif

Directive : AddIcon

Définit l'icône à afficher à côté du fichier dont le nom termine par nom, dans le mode FancyIndexing. Icone est soit une URL (encodée) relative sur l'icône, ou exprimée sous le format (alttext,url) dans lequel alttext est le texte alternatif utilisé sur les navigateur ne supportant pas l'affichage des images.

Nom est soit ^^DIRECTORY^^ pour les répertoires, ^^BLANKICON^^ pour les lignes vides (nécessaires pour formater l'affichage correctement), une extension de fichier, une expression contenant des métacaractères, un nom de fichier partiel ou complet. Exemples :

AddIcon (IMG,/icons/image.xbm) .gif .jpg .xbm 
AddIcon /icons/dir.xbm ^^DIRECTORY^^ 
AddIcon /icons/backup.xbm *~

La directive AddIconByType sera utilisée de préférence à la directive AddIcon, pour autant que possible.

Directive : AddIconByEncoding

Définit l'icône à afficher à côté des fichiers d'encodage encodage-MIME, dans le mode FancyIndexing. Icone est soit une URL (encodée) relative sur l'icône, ou exprimée sous le format (alttext,url) dans lequel alttext est le texte alternatif utilisé sur les navigateur ne supportant pas l'affichage des images.

Encodage-MIME est une expression pouvant contenir des métacaractères à laquelle doit correspondre le type d'encodage de contenu. Exemples:

AddIconByEncoding /icons/compress.xbm x-compress

Directive : AddIconByType

Définit l'icône à afficher à côté de fichiers de type MIME type-MIME, dans le mode FancyIndexing. Icone est soit une URL (encodée) relative sur l'icone, ou exprimée sous le format (alttext,url) dans lequel alttext est le texte alternatif utilisé sur les navigateur ne supportant pas l'affichage des images.

Type-MIME est une expression pouvant contenir de métacaractères à laquelle doit correspondre le type MIME.

Exemple :

AddIconByType (IMG,/icons/image.xbm) image/*

Directive : DefaultIcon

La directive DefaultIcon définit l'icône à afficher pour les fichiers en l'absence de toute icône spécifique, dans le mode FancyIndexing. Url est une URL relative encodée pour l'icône. Exemple :

DefaultIcon /icon/unknown.xbm

Directive : FancyIndexing

La directive FancyIndexing active l'option FancyIndexing pour un répertoire. La directive IndexOptions pourra être utilisée à la place. Notez que les directives FancyIndexing et IndexOptions peuvent s'annuler mutuellement. De préférence, on utilisera la formule IndexOptions FancyIndexing plutôt que la directive simple FancyIndexing.

Directive : HeaderName

La directive HeaderName définit le nom du fichier contenant l'en-tête insérée en début de listing. NomFichier est le nom du fichier à inclure, dont le chemin est défini relativement par rapport au répertoire à indexer. Le serveur tente tout d'abord d'inclure le fichier nomFichier.html en tant que document HTML, puis alternativement essaie d'insérer nomFichier en tant que texte brut. Exemple :

HeaderName HEADER

lorsque le répertoire /web est indexé, le serveur recherchera tout d'abord un document HTML nommé /web/HEADER.html et l'inclura s'il le trouve, autrement il inclura le fichier texte /web/HEADER, s'il existe.

Voir aussi ReadmeName.

Directive : IndexIgnore

La directive IndexIgnore précise quels fichiers doivent rester cachés dans la liste affichée. Fichier peut être une extension de fichier, un nom partiel ou complet de fichier, ou une expression contenant des métacaractères. Des instances répétées de la directive IndexIgnore ajoutent des éléments à la liste, plutôt que remplacer la liste de fichiers à ignorer. Par défaut, la liste ne contient que '.'. Exemple :

IndexIgnore README .htaccess *~

Directive : IndexOptions

La directive IndexOptions spécifie le comportement de l'indexeur de répertoire. Option peut être l'une parmi :

FancyIndexing

Active l'affichage "intelligent" de répertoires.

Notez que les directives FancyIndexing et IndexOptions peuvent s'annuler l'une l'autre. Vous utiliserez de préférence la formule IndexOptions FancyIndexing plutôt que la directive simple FancyIndexing.

IconHeight[=pixels] (Apache 1.3 et postérieures)

La présence de cette option, associée à l'option IconWidth, demande au serveur d'inclure les attributs HEIGHT et WIDTH dans la balise IMG servant à inclure l'icône de fichier. Ceci permet au navigateur de calculer la mise en page à l'avance, sans avoir à attendre que toutes les images aient été chargées. Si aucune valeur n'est précisée pour cette option, la valeur utilisée par défaut est la hauteur des icônes standard livrées dans la distribution d'Apache.

IconsAreLinks

Intègre les icônes dans le lien constitué par le nom de fichier, dans le mode FancyIndexing.

IconWidth[=pixels] (Apache 1.3 et postérieures)

La présence de cette option, associée à l'option IconHeight, demande au serveur d'inclure les attributs HEIGHT et WIDTH dans la balise IMG servant à inclure l'icône de fichier. Ceci permet au navigateur de calculer la mise en page à l'avance, sans avoir à attendre que toutes les images aient été chargées. Si aucune valeur n'est précisée pour cette option, la valeur utilisée par défaut est la largeur des icônes standard livrées dans la distribution d'Apache.

ScanHTMLTitles

Autorise l'extraction des titres des documents HTML pour renseigner la liste en mode FancyIndexing. Si le fichier n'est pas associé à une description (via une directive AddDescription), alors httpd ouvrira le document pour trouver le contenu de la balise <TITLE>...</TITLE>. Ceci est cependant très coûteux en temps CPU et en accès disques.

SuppressColumnSorting

Si précisé, Apache ne transformera pas les titres de colonnes d'un affichage FancyIndexed en liens d'accès à la fonction de tri. Le comportement par défaut est celui des listes triées : la sélection de la tête de colonne provoquera une remise à jour triée de la liste selon les valeurs contenues dans cette colonne. Seulement à partir de la version 1.3 d'Apache.

SuppressDescription

Supprime la colonne de description de fichier dans un affichage en mode FancyIndexong.

SuppressHTMLPreamble

Si le répertoire contient un fichier dont le nom correspond à celui spécifié dans une directive HeaderName, le module inclura habituellement le contenu de ce fichier après le préambule HTML standard (<HTML>, <HEAD>, et cetera). L'option SuppressHTMLPreamble annule ce comportement, en démarrant l'affichage de la liste directement par le contenu du fichier d'en-tête. Celui-ci devra contenir son propre préambule HTML. Si le fichier d'en-tête n'est pas trouvé, le préambule sera à nouveau transmis.

SuppressLastModified

Cette option supprime l'affichage de la colonne indiquant la date de dernière modification de la ressource, dans le mode FancyIndexing.

SuppressSize

Cette option supprime l'affichage de la taille des ressources dans le mode FancyIndexing.

Par défaut, aucune option est active. Si plusieurs IndexOptions sont applicables à un répertoire, alors celle qui est appliquée est la plus "intérieure" ; les options ne sont donc pas combinées. Par exemple :

<Directory /web/docs> 
IndexOptions FancyIndexing 
</Directory>
<Directory /web/docs/spec> 
IndexOptions ScanHTMLTitles 
</Directory>

Seule l'option ScanHTMLTitles sera activée pour le répertoire /web/docs/spec.

Directive : ReadmeName

La directive ReadmeName définit le nom d'un fichier qui sera inséré en fin d'index. nomFichier est le nom du fichier à inclure, et est spécifié relativement au répertoire indexé. Le serveur tente d'abord d'inclure le fichier nomFichier.html en tant que document HTML, alternativement, il tentera ensuite d'insérer le fichier nomFichier comme un fichier texte brut.

Exemple :

ReadmeName README

Lors de l'indexage du répertoire /web, le serveur cherchera d'abord un fichier HTML de nom /web/README.html et l'inclura s'il le trouve, autrement, il tentera d'inclure le fichier texte /web/README, si celui-ci existe.

Voir également HeaderName.

Apache HTTP Server Version 1.3

Adaptation française © Valery Fremaux / EISTI 1998