Module Apache mod_autoindex

AddAlt Directive

La directive AddAlt permet d'afficher un texte optionnel pour un fichier, � la place d'un ic�ne, dans le cas d'un affichage FancyIndexing. fichier est une extension de fichier, un nom de fichier partiel, une expression avec caract�res g�n�riques ou un nom de fichier complet permettant de caract�riser le(s) fichier(s) concern�(s). Si texte contient des espaces, vous devez l'entourer de guillemets ou d'apostrophes (" ou '). Ce texte optionnel sera affich� si le client ne peut pas afficher d'images, si le chargement d'images est d�sactiv� ou si l'ic�ne ne peut pas �tre trouv�.

AddAlt "PDF file" *.pdf
AddAlt Compressed *.gz *.zip *.Z

AddAltByEncoding Directive

La directive AddAltByEncoding permet d'afficher un texte optionnel � la place d'un ic�ne pour un fichier dans le cas d'un affichage FancyIndexing. codage MIME doit �tre un type valide, comme x-compress. Si texte contient des espaces, vous devez l'entourer de guillemets ou d'apostrophes (" ou '). Ce texte optionnel sera affich� si le client ne peut pas afficher d'images, si le chargement d'images est d�sactiv� ou si l'ic�ne ne peut pas �tre trouv�.

AddAltByEncoding gzip x-gzip

AddAltByType Directive

La directive AddAltByType permet d'afficher un texte optionnel � la place d'un ic�ne pour un fichier dans le cas d'un affichage FancyIndexing. type MIME doit �tre un type MIME valide, comme text/html. Si texte contient des espaces, vous devez l'entourer de guillemets ou d'apostrophes (" ou '). Ce texte optionnel sera affich� si le client ne peut pas afficher d'images, si le chargement d'images est d�sactiv� ou si l'ic�ne ne peut pas �tre trouv�.

AddAltByType 'Fichier texte' text/plain

AddDescription Directive

Cette directive permet d'afficher une description pour un fichier, dans le cas d'un affichage FancyIndexing. fichier est une extension de fichier, un nom de fichier partiel, une expression avec caract�res g�n�riques ou un nom de fichier complet permettant de caract�riser le fichier. texte doit �tre entour� de guillemets (").

AddDescription "The planet Mars" mars.gif
AddDescription "My friend Marshall" friends/mars.gif

La taille par d�faut, habituelle du champ de description est de 23 octets. L'option IndexOptions SuppressIcon ajoute 6 octets, l'option IndexOptions SuppressSize en ajoute 7 et l'option IndexOptions SuppressLastModified en ajoute 19. Ainsi, la plus grande taille par d�faut qui peut �tre assign�e � la colonne description est de 55 octets.

Comme l'argument fichier peut �tre un nom de fichier partiel, vous devez garder � l'esprit qu'un nom de fichier partiel trop court pourra correspondre � des fichiers non voulus. Par exemple, le.html correspondra au fichier le.html, mais aussi au fichier example.html. En cas d'ambigu�t�, utilisez un nom de fichier aussi complet que possible, et ordonnez votre liste de directives AddDescription en cons�quence.

Voir le mot-cl� DescriptionWidth de la directive module="mod_autoindex">IndexOptions pour plus de d�tails sur la mani�re d'augmenter la taille de cette colonne, ou pour permettre des descriptions de taille illimit�e.

AddIcon Directive

Cette directive permet de d�terminer l'ic�ne � afficher � c�t� d'un fichier dont le nom se termine par nom, dans le cas d'un affichage FancyIndexing. ic�ne est une URL relative (�chapp�e par des caract�res '%') vers l'ic�ne, une URL distante pleinement qualifi�e, ou de la forme (alttext,url), o� alttext est le symbole texte correspondant � l'ic�ne � afficher dans les navigateurs en mode texte.

nom correspond � ^^DIRECTORY^^ pour les r�pertoires, ^^BLANKICON^^ pour les lignes vides (pour personnaliser la pr�sentation du listing), une extension de fichier, une expression avec caract�res g�n�riques, un nom de fichier partiel ou un nom de fichier complet.

^^BLANKICON^^ n'est utilis� que pour le formatage, et n'est donc pas n�cessaire si vous utilisez IndexOptions HTMLTable.

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

Lorsque c'est possible, il est pr�f�rable d'utiliser AddIconByType plut�t que AddIcon.

AddIconByEncoding Directive

Cette directive permet de d�terminer l'ic�ne � afficher � c�t� d'un fichier dans le cas d'un affichage FancyIndexing. ic�ne est une URL relative (�chapp�e par des caract�res '%') vers l'ic�ne, une URL pleinement qualifi�e, ou de la forme (alttext,url), o� alttext est le symbole texte correspondant � l'ic�ne � afficher dans les navigateurs en mode texte.

codage MIME doit �tre un codage valide, comme x-compress.

AddIconByEncoding /icons/compress.png x-compress

AddIconByType Directive

Cette directive permet de d�terminer l'ic�ne � afficher � c�t� d'un fichier de type MIME type MIME dans le cas d'un affichage FancyIndexing. ic�ne est une URL relative (�chapp�e par des caract�res '%') vers l'ic�ne, une URL pleinement qualifi�e, ou de la forme (alttext,url), o� alttext est le symbole texte correspondant � l'ic�ne � afficher dans les navigateurs en mode texte.

type MIME est une expression avec caract�res g�n�riques repr�sentant le type MIME.

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

DefaultIcon Directive

La directive DefaultIcon permet de d�finir l'ic�ne � afficher � c�t� d'un fichier lorsqu'aucun ic�ne sp�cifique n'a �t� pr�cis�, dans le cas d'un affichage FancyIndexing. chemin URL est une URL relative (�chapp�e par des caract�res '%') vers l'ic�ne ou une URL pleinement qualifi�e.

DefaultIcon /icon/unknown.png

HeaderName Directive

La directive HeaderName permet de d�finir le nom du fichier qui sera ins�r� au d�but de la page contenant l'index. nom fichier est le nom du fichier � inclure.

HeaderName HEADER.html

HeaderName /include/HEADER.html

AddType text/html .cgi

Si le fichier sp�cifi� par la directive HeaderName contient les en-t�tes d'un document HTML ((<html>, <head>, etc...), vous serez probablement amen� � d�finir IndexOptions +SuppressHTMLPreamble, de mani�re � ce que ces balises ne soient pas r�p�t�es.

Voir aussi

• ReadmeName

IndexHeadInsert Directive

La directive IndexHeadInsert permet de sp�cifier une cha�ne de caract�res � ins�rer dans la section <head> du code HTML g�n�r� pour la page d'index.

IndexHeadInsert "<link rel=\"sitemap\" href=\"/sitemap.html\">"

IndexIgnore Directive

La directive IndexIgnore permet d'effectuer des ajouts � la liste des fichiers � cacher lors de l'affichage de l'index d'un r�pertoire. fichier est une expression avec caract�res g�n�riques de style shell ou un nom de fichier complet. Plusieurs directives IndexIgnore effectuent des ajouts � la liste, et ne remplacent pas la liste des fichiers � ignorer. Par d�faut, la liste contient . (le r�pertoire courant).

IndexIgnore .??* *~ *# HEADER* README* RCS CVS *,v *,t

IndexIgnoreReset Directive

La directive IndexIgnoreReset supprime toute liste de fichiers d�finie par la directive IndexIgnore et h�rit�e par ailleurs d'autres sections de configuration.

<Directory /var/www>
    IndexIgnore *.bak .??* *~ *# HEADER* README* RCS CVS *,v *,t
</Directory>
<Directory /var/www/backups>
    IndexIgnoreReset ON
    IndexIgnore .??* *# HEADER* README* RCS CVS *,v *,t
</Directory>

IndexOptions Directive

La directive IndexOptions permet de sp�cifier les options de configuration de l'indexation du r�pertoire. option peut prendre l'une des valeurs suivantes :

AddAltClass

Ajoute une d�claration de classe CSS suppl�mentaire � chaque enregistrement de la table du listing du r�pertoire dans le cas o� IndexOptions HTMLTable est activ� et o� un IndexStyleSheet a �t� d�fini. Plut�t que d'appliquer � chaque enregistrement de la table les classes standards even et odd, c'est ici une classe even-ALT ou odd-ALT qui sera appliqu�e, o� ALT sera soit le texte alternatif standard associ� au style du fichier (par exemple snd, txt, img, etc...), soit le texte alternatif d�fini par une des diff�rentes directives AddAlt*.

Charset=jeu de caract�res (Versions 2.0.61 et sup�rieures du serveur HTTP Apache)

Le mot-cl� Charset vous permet de sp�cifier le jeu de caract�res de la page g�n�r�e. La valeur par d�faut est UTF-8 sous Windows et MAC OS X, et ISO-8859-1 dans les autres cas (en fait selon que le syst�me de fichiers sous-jacent utilise les noms de fichiers en Unicode ou non).

IndexOptions Charset=UTF-8

DescriptionWidth=[n | *]

Le mot-cl� DescriptionWidth vous permet de sp�cifier la taille en caract�res de la colonne description.

Avec -DescriptionWidth (ou si l'option n'est pas d�finie), mod_autoindex calcule la meilleure taille.

DescriptionWidth=n fixe la taille de la colonne � n octets.

DescriptionWidth=* ajuste la taille de la colonne � la plus longue cha�ne de description.

Voir la section concernant AddDescription pour les dangers inh�rants � la troncature des descriptions.

FancyIndexing

Cette option active l'indexation "am�lior�e" des r�pertoires, c'est � dire avec en-t�tes de colonnes sous forme d'hyper-liens auto-r�f�rants.

FoldersFirst

Lorsque cette option est activ�e, la liste des sous-r�pertoires appara�tra toujours en premier, suivie de la liste des fichiers normaux du r�pertoire. Le listing comporte principalement deux parties, les fichiers et les sous-r�pertoires, chacun d'eux �tant tri� s�par�ment et les sous-r�pertoires affich�s en premier. Par exemple, si l'ordre de tri est d�croissant par nom, et si FoldersFirst est activ�, le sous-r�pertoire Zed sera affich� avant le sous-r�pertoire Beta, qui sera lui-m�me affich� avant les fichiers normaux Gamma et Alpha. Cette option n'a d'effet que si FancyIndexing est aussi activ�.

HTMLTable

Cette option pour l'affichage FancyIndexing permet de construire une table simple pour l'affichage de l'index du r�pertoire. Cette option s'av�rera particuli�rement n�cessaire pour les plates-formes o� utf-8 est activ� et dans le cas o� les noms de fichiers ou les cha�nes de description alternent entre les ordres de lecture gauche � droite et droite � gauche.

IconsAreLinks

Configure la partie r�serv�e aux ic�nes de l'ancrage pour le nom de fichier, dans le cas d'un affichage "am�lior�".

IconHeight[=pixels]

Si cette option est pr�sente, en combinaison avec IconWidth, le serveur va inclure les attributs height et width dans la balise img qui r�f�rence le fichier de l'ic�ne. Ceci va permettre au navigateur de pr�voir les caract�ristiques de la page sans devoir attendre que toutes les images aient �t� charg�es. En l'absence de cette option, c'est la hauteur standard d�finie par le logiciel Apache httpd qui est choisie comme valeur par d�faut.

IconWidth[=pixels]

Si cette option est pr�sente, en combinaison avec IconHeight, le serveur va inclure les attributs height et width dans la balise img qui r�f�rence le fichier de l'ic�ne. Ceci va permettre au navigateur de pr�voir les caract�ristiques de la page sans devoir attendre que toutes les images aient �t� charg�es. En l'absence de cette option, c'est la largeur standard d�finie par le logiciel Apache httpd qui est choisie comme valeur par d�faut.

IgnoreCase

Si cette option est activ�e, les noms sont tri�s sans tenir compte de la casse. Par exemple, si le tri s'effectue sur les noms dans l'ordre croissant, et si IgnoreCase est activ�, le fichier Zeta appara�tra apr�s le fichier alfa (Note : le fichier GAMMA appara�tra toujours avant le fichier gamma).

IgnoreClient

Si cette option est activ�e, mod_autoindex va ignorer toutes les variables de requ�te fournies par le client, y compris les informations de tri (ce qui implique l'activation de l'option SuppressColumnSorting).

NameWidth=[n | *]

Le mot-cl� NameWidth vous permet de sp�cifier la largeur en octets de la colonne correspondant au nom du fichier.

Avec -NameWidth (ou si l'option n'est pas d�finie), mod_autoindex va calculer la meilleure largeur possible, mais jusqu'� une largeur maximale de 20 octets.

NameWidth=n fixe la largeur de la colonne � n octets.

NameWidth=* d�finit la largeur de colonne � la valeur n�cessaire.

ScanHTMLTitles

L'activation de cette option permet d'extraire le titre des documents HTML dans le cas d'un affichage "am�lior�". Si le fichier ne poss�de aucune description d�finie par la directive AddDescription, httpd va lire le document pour tenter d'en extraire le titre. Ce processus est co�teux en ressources disque et CPU.

ShowForbidden

Si cette option est activ�e, Apache httpd affichera les fichiers normalement cach�s suite au retour des valeurs HTTP_UNAUTHORIZED ou HTTP_FORBIDDEN par la sous-requ�te.

SuppressColumnSorting

Si cette option est activ�e, Apache httpd supprimera les liens hyper-texte dans les en-t�tes de colonnes dans le cas d'un affichage "am�lior�". Par d�faut, ces en-t�tes constituent des liens hyper-texte, et la s�lection de l'un d'entre eux va trier l'index du r�pertoire en fonction des valeurs de la colonne correspondante. Cependant, les arguments de la cha�ne de param�tres de la requ�te ajout�s � l'URL seront toujours ignor�s. Ce comportement est contr�l� par l'option IndexOptions IgnoreClient.

SuppressDescription

L'activation de cette option va supprimer la description des fichiers dans le cas d'un affichage "am�lior�". Par d�faut aucune description de fichier n'est d�finie, et par cons�quent l'utilisation de cette option va permettre de r�cup�rer un espace � l'�cran de 23 caract�res pouvant �tre utilis� pour autre chose. Voir la directive AddDescription pour plus d'informations � propos de la d�finition des descriptions de fichiers. Voir aussi l'option d'index DescriptionWidth pour limiter la taille de la colonne description.

SuppressHTMLPreamble

Si le r�pertoire contient effectivement le fichier sp�cifi� par la directive HeaderName, le module inclut en g�n�ral le contenu du fichier apr�s avoir ins�r� un pr�ambule HTML standard (<html>, <head>, etc...). L'activation de l'option SuppressHTMLPreamble supprime l'insertion de ce pr�ambule, et le module va alors commencer l'affichage directement par le contenu du fichier d'en-t�te. Dans ce cas par contre, le fichier d'en-t�te doit contenir des instructions HTML appropri�es. S'il n'y a pas de fichier d'en-t�te, le pr�ambule est g�n�r� comme dans le cas g�n�ral. Si vous sp�cifiez aussi une directive ReadmeName, et si ce fichier existe, les balises de fermeture closing </body></html> seront aussi omises dans la sortie, en supposant que vous ayez plac� ces balises de fermeture dans ce fichier.

SuppressIcon

L'activation de cette option supprime l'affichage des ic�nes dans le cas d'un affichage "am�lior�". La combinaison de SuppressIcon et SuppressRules permet de g�n�rer une sortie au format HTML 3.2 qui, selon les derni�res sp�cifications, interdit les �l�ments img et hr dans les blocs pre (utilis�s pour formater les affichages "am�lior�s").

SuppressLastModified

L'activation de cette option supprime l'affichage de la date de derni�re modification dans le cas d'un affichage "am�lior�".

SuppressRules

L'activation de cette option supprime l'affichage des lignes horizontales (�l�ments hr) dans les index de r�pertoires. La combinaison de SuppressIcon et SuppressRules permet de g�n�rer une sortie au format HTML 3.2 qui, selon les derni�res sp�cifications, interdit les �l�ments img et hr dans les blocs pre (utilis�s pour formater les affichages "am�lior�s").

SuppressSize

L'activation de cette option supprime l'affichage de la taille du fichier dans le cas d'un affichage "am�lior�".

TrackModified

Cette option renvoie les valeurs Last-Modified et ETag pour le r�pertoire index� dans l'en-t�te HTTP. Elle n'est valide que si le syst�me d'exploitation et le syst�me de fichiers renvoient des r�sultats appropri�s pour la fonction stat(). C'est le cas de certains syst�mes Unix, ainsi que JFS sous OS/2 ou les volumes NTFS sous Win32. Ce n'est par contre pas le cas des volumes FAT Win32 et OS/2. Lorsque cette option est activ�e, le client ou le mandataire peuvent d�tecter les changements dans la liste des fichiers lorsqu'ils effectuent une requ�te HEAD. Notez que certains syst�mes d'exploitation d�tectent correctement les nouveaux fichiers et les fichiers supprim�s, mais ne d�tectent pas les modifications de tailles ou de dates des fichiers du r�pertoire. Les modifications de taille ou de date d'un fichier existant ne mettent pas � jour l'en-t�te Last-Modified sur toutes les plate-formes Unix. Si c'est le cas, laissez cette option d�sactiv�e.

Type=type MIME (Versions 2.0.61 et sup�rieures du serveur HTTP Apache)

Le mot-cl� Type vous permet de sp�cifier le type MIME de la page g�n�r�e. La valeur par d�faut est text/html.

IndexOptions Type=text/plain

VersionSort (Versions 2.0a3 et sup�rieures du serveur HTTP Apache)

Le mot-cl� VersionSort permet de trier les fichiers contenant des num�ros de version d'une mani�re sp�cifique. Les cha�nes sont tri�es comme d'habitude, except� les sous-cha�nes de chiffres du nom de fichier et de sa description qui sont compar�es en fonction de leur valeur num�rique.

Exemple :

foo-1.7
foo-1.7.2
foo-1.7.12
foo-1.8.2
foo-1.8.2a
foo-1.12

Si le nombre commence par le chiffre 0, il est consid�r� comme la partie fractionnaire d'un nombre :

foo-1.001
foo-1.002
foo-1.030
foo-1.04

XHTML (Versions 2.0.49 et sup�rieures du serveur HTTP Apache)

Le mot-cl� XHTML enjoint mod_autoindex de g�n�rer du code XHTML 1.0 au lieu de HTML 3.2.

Options d'index incr�mentales

Vous devez porter une attention particuli�re � la mani�re dont les IndexOptions multiples sont trait�es.

• Plusieurs directives IndexOptions apparaissant dans la m�me section directory sont maintenant fusionn�es. Le r�sultat de :

  <Directory /foo>
      IndexOptions HTMLTable
      IndexOptions SuppressColumnsorting
  </Directory>

  est �quivalent �

  IndexOptions HTMLTable SuppressColumnsorting

• L'ajout de la syntaxe incr�mentale (en pr�fixant les mots-cl�s avec + ou -).

Chaque fois qu'un mot-cl� pr�fix� par '+' ou '-' est trouv�, il est appliqu� aux d�finitions des IndexOptions courantes (qui ont �t� �ventuellement h�rit�es d'un directory de niveau sup�rieur). Par contre, si un mot-cl� non pr�fix� est trouv�, il supprime toutes les definitions h�rit�es, ainsi que toute d�finition incr�mentale. Consid�rons l'exemple suivant :

IndexOptions +ScanHTMLTitles -IconsAreLinks FancyIndexing

IndexOptions +SuppressSize

L'effet global est �quivalent � l'effet qu'aurait provoqu� IndexOptions FancyIndexing +SuppressSize, car l'option non pr�fix�e FancyIndexing annule les mots-cl�s incr�mentaux situ�s avant elle, mais leur permet ensuite de s'incr�menter � nouveau.

Pour d�finir inconditionnellement les IndexOptions pour un r�pertoire particulier, tout en supprimant les d�finitions h�rit�es, sp�cifiez les mots-cl�s sans pr�fixe + ou -

IndexOrderDefault Directive

La directive IndexOrderDefault s'utilise en combinaison avec l'option d'index FancyIndexing. Par d�faut, les index de r�pertoires "am�lior�s" sont affich�s selon l'ordre croissant des noms de fichiers ; la directive IndexOrderDefault vous permet de modifier ce comportement.

La directive IndexOrderDefault accepte deux arguments. Le premier est soit Ascending, soit Descending, et indique l'ordre de tri. Le second doit prendre une des valeurs Name, Date, Size, ou Description, et permet d'identifier la cl� primaire. La cl� secondaire est toujours le nom du fichier selon un ordre croissant.

Si vous le d�sirez, vous pouvez emp�cher le client de modifier l'ordre de tri de la liste en ajoutant l'option d'index SuppressColumnSorting qui supprime le lien de d�finition du tri de l'en-t�te de la colonne, ainsi que l'option IgnoreClient qui emp�che ce m�me client de passer outre vos pr�f�rences de tri en ajoutant manuellement des options de tri � la cha�ne de param�tres de la requ�te.

IndexStyleSheet Directive

La directive IndexStyleSheet permet de d�finir le nom du fichier qui servira de feuille de style CSS pour l'index.

IndexStyleSheet "/css/style.css"

L'utilisation de cette directive en conjonction avec IndexOptions HTMLTable ajoute plusieurs classes CSS au document HTML r�sultant. Un identifiant CSS indexlist est attribu� � l'ensemble de la table et les classes suivantes sont associ�es aux diff�rentes parties du listing :

ReadmeName Directive

La directive ReadmeName permet de d�finir le nom du fichier dont le contenu sera ajout� � la fin de l'index. nom-fichier est le nom du fichier � inclure, et est consid�r� comme relatif au r�pertoire faisant l'objet de l'index. Si nom-fichier commence par un slash '/', comme dans l'exemple 2, il sera consid�r� comme relatif au r�pertoire d�fini par la directive DocumentRoot.

# Example 1
ReadmeName FOOTER.html

# Example 2
ReadmeName /include/FOOTER.html

Voir aussi la directive HeaderName, o� cette fonctionnalit� est d�crite plus en d�tails.