Le Manuel de Programmation de KDevelop: Le Système de Fichiers Standard de KDE

Page suivante Page précédente Table des matières

### 13. Le Système de Fichiers Standard de KDE

Ce chapitre est une copie du Système de Fichiers Standard de KDE (NdT : KDE FSSTD) écrit par Richard Moore rich@kde.org et publié sur le site web de KDE à http://www.kde.org.

Système de Fichiers Standard de KDE

Ce fichier documente la structure de répertoires que KDE et toutes les applications compatibles avec KDE doivent utiliser. Ceci est la version 0.0.4 du standard.

### 13.1 Introduction

Le but du KDE FSSTD est de s'assurer que toutes les ressources (icônes, types Mime, etc) requises par les applications KDE sont stockées dans une structure de répertoires cohérente. Suivre cette structure permet aux applications d'utiliser des outils comme la classe KIconLoader et de séparer les données nécessaires à KDE spécifiques à la plate-forme des données indépendantes de la plate-forme (rendant possible l'installation de plusieurs architectures). Dans ce document, les noms des répertoires se terminent par le caractère `/`. Lorsque le mot 'appname' apparaît entre inférieur/supérieur <comme ceci>, cela signifie qu'il devrait y avoir une entrée correspondante pour chaque application KDE installée. Le mot 'lang' est utilisé de la même façon pour indiquer qu'il doit y avoir une entrée pour chaque langue supportée selon le système de nommage à deux caractères (par exemple : 'fr' pour Français, 'de' pour Allemand).

### 13.2 Organisation des Répertoires

La structure de répertoires de KDE est indiquée ci-dessous, la racine de l'arborescence d'installation de KDE est souvent '/opt/kde' mais peut être déterminée à l'exécution en utilisant la méthode kdedir() de KApplication (cela remplace la variable d'environnement KDEDIR dont l'utilisation est maintenant obsolète). Ce document utilise kdedir() pour dénoter ce répertoire.

- kdedir()/
  - bin/
    - Binaires des applications
  - lib/
    - bibliothèques standards de kde (libkdecore, etc.)
    - <appname>/
      - Données spécifiques de l'application dépendantes de la plate-forme
  - include/
    - fichiers d'en-tête standards de kde
  - parts/
  - cgi-bin/
    - programmes CGI pour kdehelp
  - share/
    - doc/
      - HTML/
        - default --> Lien vers kdedir()/share/doc/HTML/en
        - <lang>/
          - <appname>/
            - index.html
            - autres fichiers d'aide de l'application
    - config/
    - applnk/
      - System/
      - Utilities/
      - Applications/
      - Games/
      - kfind.kdelnk
      - khelp.kdelnk
      - khome.kdelnk
      - krefresh.kdelnk
    - mimelnk/
      - magic
      - text/
      - audio/
    - partlnk/
      - <partname>.kdelnk
    - icons/
      - Icônes utilisées dans les fichiers kdelnk
      - <appname>.xpm
      - mini/
        - Mini-icônes pour kpanel
    - toolbar/
      - Pixmaps standard de barre d'outils (par ex : fileopen.xpm)
    - wallpapers/
      - Papiers peints utilisés par kdisplay
    - apps/
      - <appname>/
        - toolbar/
          - Pixmaps de barre d'outils
        - pics/
          - Autres pixmaps de l'application
        - Données spécifiques à l'application (indépendantes de la plate-forme)
      - <libname>/
        - pics/
    - locale/
      - <lang>/
        - LC_MESSAGES/
          - <appname>.mo

### 13.3 Ce que cela signifie pour les développeurs d'application

Une application KDE standard installera ses fichiers à différents endroits dans la structure ci-dessus. Les seuls éléments nécessaires sont le binaire de l'application, le fichier kdelnk de l'application, l'icône de l'application et les fichiers d'aide de l'application - tous les autres sont facultatifs. Les choses les plus couramment installées sont :

> `

>     Type de fichier                                   Emplacement

>     Binaire de l'application (requis)                 kdedir()/bin/
>     Fichier kdelnk de l'application (requis)          kdedir()/share/applnk/
>     Icône de l'application icon (requis)              kdedir()/share/icons/<appname>.xpm
>     Fichiers d'aide de l'application (requis)         kdedir()/share/doc/default/HTML/<appname>/<index>.html
>     Pixmaps de la barre d'outils de l'application     kdedir()/share/apps/<appname>/toolbar/
>     Données de l'application (pour la plate-forme)    kdedir()/share/apps/<appname>/
>     Données de l'application (non-spécifiques)        kdedir()/lib/<appname>/

> `

### 13.4 Documentation de l'Application

J'ai suggéré de mettre nécessairement au moins une page dans

kdedir()/doc/default/HTML/<appname>/<appname>.html

pour toute application KDE. L'application est libre d'utiliser le répertoire pour stocker toutes les données liées à l'aide dont elle a besoin.

Les applications qui supportent plus d'une langue devront placer les autres langues dans kdedir()/doc/<lang>/HTML/<appname>/<appname>.html avec, comme d'habitude, un répertoire 'lang' pour chaque code de langue. En organisant les fichiers de la sorte, des liens pourront être créés entre les fichiers d'aide de deux applications différentes qui supportent toutes les deux une langue donnée.

Je ne suis pas 100 % satisfait de la solution que j'ai suggérée car elle ne permet pas de se rabattre sur une langue par défaut si une traduction requise n'est pas disponible.

### 13.5 Ce que cela signifie pour les développeurs de bibliothèques

- kdedir()/share/apps/<libname>/toolbar

Icônes des barres d'outils pour les widgets de la bibliothèque

- kdedir()/share/apps/<libname>/pics

Toute autre image bitmap pour les widgets de la bibliothèque

Page suivante Page précédente Table des matières