History

Modules¶

On appelle module un ensemble homogène d'informations, pouvant être appelé par une trame et constituer in fine une partie de la documentation publiée.

Créer un nouveau module¶

Pour créer un nouveau module :

Parcourez l'onglet Modules jusqu'à l'emplacement du futur module, dans le sous-répertoire correspondant à la langue source (ex : fr).
Cliquez sur Nouveau module.
Saisissez le nom du module à créer (sans extension). Pour prévenir tout risque d'erreur lié au gestionnaire de fichiers (qui dysfonctionne parfois lorsqu'il s'agit de lire de l'UTF-8), ne pas utiliser d'accents, d'espaces ou de caractères spéciaux dans les noms de modules.
Sélectionnez le modèle à utiliser. Les modèles proposés dans la liste sont des modules xhtml types, stockés dans le répertoire autres/modeles/modules.
Validez.

L'extension est ajoutée automatiquement au nom du nouveau module. Elle est définie dans le fichier _conf.xml de la base. Dans l'exemple ci-dessus, l'intérêt de choisir ".xht" est de pouvoir lui associer une application particulière dédiée à l'édition (Amaya, NVU, etc.), alors qu'une extension classique du HTML (.htm ou .html) ouvre par défaut un navigateur internet.

Éditer un module¶

Le fait de cliquer sur le nom du module entraîne son ouverture dans le navigateur, en lecture seule.

Pour pouvoir éditer (modifier, enregistrer) le module, installez le plugin ViewSourceWith, qui vous permettra d'ouvrir le module avec Amaya, et disposer ainsi d'un environnement d'édition évolué, avec vue simultanée de la structure du document.

Cet environnement est particulièrement adapté à l'utilisation de kOLEKTi, car il permet facilement de sélectionner des éléments (h1, p, table, etc.) et de leur attribuer des conditions.

Structure et contenu

Un module contient généralement plusieurs paragraphes, structurés ou non à l'aide de titres (h1, h2, etc.). Il s'agit d'une structuration logique : un titre de niveau 1 (h1) peut devenir un titre de niveau 3 (h3) si le module est référencé au troisième niveau d'une trame.

Le périmètre du module dépend en grande partie du type de publication envisagé. Un module pourra être assez volumineux et correspondre à un chapitre dans le cas d'une publication papier, alors qu'il sera plus court (pour correspondre à un topic) dans le cas d'une publication de type "aide en ligne".

Plus un module est petit, plus il a la possibilité d'être ré-utilisé dans différents contextes et différentes publications. En revanche, la gestion d'une multitude de "micro-modules" devient vite compliquée. C'est pourquoi nous préconisons des modules complets par sujet (ex : consignes de sécurité), quitte à utiliser de manière intensive les parties conditionnelles à l'intérieur des modules.

Feuilles de style

Lors de la création d'un nouveau module, deux feuilles de styles lui sont associées :

module.css, qui définit l'apparence générale du module lors de son édition (polices, mise en valeur des variables, justification du texte, etc.). Cette feuille de style est librement modifiable par l'utilisateur.
criteres.css, qui est destinée à mettre en valeur les parties conditionnelles du module. Cette feuille de style est générée automatiquement par kOLEKTi lors de la sauvegarde de la configuration de la base.

Ces deux feuilles de styles sont situées dans le répertoire styles de la base.

C'est la feuille module.css qui surcharge (c-à-d qui a la priorité, en cas de différence sur un même élément) la feuille criteres.css.

Les feuilles de style ne sont utilisées que pour l'édition du module. Elles ne sont pas conservées lors du processus de publication.

Note : le style utilisé pour la publication est défini dans chaque ordre de publication.

Sauvegarde

La sauvegarde du module s'effectue via l'éditeur. Dans Amaya, cliquez sur Fichier / Enregistrer.

Attention : selon la disponibilité du réseau, la sauvegarde peut n'être effective qu'après quelques secondes. Patientez pendant ce délai.

A chaque sauvegarde la version précédente du module est enregistrée dans le sous-répertoire _backups.

Renommer un module¶

Pour renommer un module :

double-cliquez sur le pictogramme "page" situé à gauche du nom du module
renommez le module (en conservant l'extension intacte)
validez à l'aide de la touche Entrée de votre clavier

Attention : si le module était référencé avec son ancien nom dans une ou plusieurs trames, pensez à mettre à jour ces dernières.

Dupliquer un module¶

Pour dupliquer un module :

ouvrez le module à dupliquer dans Amaya
cliquez sur Fichier / Enregistrer sous et indiquez le nom (et éventuellement l'emplacement, si différent) du nouveau module.

Supprimer un module¶

Pour supprimer un module :

cochez la case située à gauche du module
cliquez sur Supprimer
Attention : après validation de la suppression, il n'est plus possible de récupérer le module (pas de presse-papier dans les applications web)

Gérer les dossiers de modules¶

Pour créer un sous-répertoire dans le dossier Modules :

dans l'onglet Modules, cliquez sur Créer dossier
saisissez le nom du dossier à créer puis validez
La création d'un dossier entraîne automatiquement la création d'un sous-répertoire de langue correspondant à la langue de rédaction (définie dans la configuration de la base).

Les modules doivent obligatoirement être situés dans un répertoire de langue (quel que soit sont emplacement).

Pour créer un répertoire de langue, utilisez l'explorateur de fichiers, en prenant soin de respecter les codes langue définis dans la configuration de la base.

En-tête standard¶

L'en-tête standard d'un module est le suivant :

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" 
      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" 
 xmlns:xlink="http://www.w3.org/1999/xlink">
<head>
  <meta http-equiv="content-type" 
  content="application/xhtml+xml; charset=UTF-8" />
  <title>Titre du module</title>
  <meta content="topic_file" name="titre topic" />

Déclaration XML, codage des caractères

Les modules sont au format XHTML 1.0 strict. Ils peuvent inclure l'ensemble des fonctionnalités de ce format, qui seront conservées par kOLEKTi lors de la phase d'assemblage et seront présentes dans le document pivot (également au format XHTML 1.0).

Les modules doivent être codés en UTF-8.

xx à préciser/modifier

Déclaration du DOCTYPE