Extended guidelines for xml-compliance
This commit is contained in:
martignoni
@@ -1,15 +1,22 @@
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
|
||||
<head>
|
||||
|
||||
<title>Documentation Moodle : Guide de traduction de Moodle</title>
|
||||
|
||||
<link rel="stylesheet" href="docstyles.css" type="text/css" />
|
||||
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
||||
|
||||
<style type="text/css">
|
||||
<!--
|
||||
ol {margin-left:80px;}
|
||||
-->
|
||||
</style>
|
||||
|
||||
</head>
|
||||
|
||||
<body style="background-color: #ffffff;">
|
||||
@@ -40,7 +47,18 @@
|
||||
|
||||
<p style="margin-left: 40px;">Pour ce faire, commencez par créer un nouveau dossier dans le dossier <strong>lang</strong> en utilisant pour son nom le code à 2 lettres de votre langue. Ces codes standard sont décrits dans le fichier <strong>lib/languages.php</strong>. Si vous faites simplement une adaptation locale d'une autre langue, utilisez comme nom le code de cette langue, suivi d'un caractère souligné et d'une extension significative de 2 lettres. Par exemple la langue française est désignée par <em>fr</em>, et le canadien-français par <em>fr_ca</em>. Si vous faites une version Unicode d'une traduction, ajoutez <em>_utf8</em> à la fin (par exemple <em>fr_utf8</em>).</p>
|
||||
|
||||
<p style="margin-left: 40px;">Ensuite, copiez le fichier <strong>moodle.php</strong> d'une autre langue dans votre nouveau dossier. Celui du dossier <strong>en</strong> est le plus actuel, mais peu importe puisque vous allez de toute façon le réécrire.</p>
|
||||
<p style="margin-left: 40px;">Ensuite, créez dans votre dossier un nouveau fichier "moodle.php" contenant les lignes suivantes :<br /><br />
|
||||
|
||||
<code>
|
||||
<?php <br />
|
||||
$string['thischarset'] = 'iso-8859-1';<br />
|
||||
$string['thisdirection'] = 'ltr';<br />
|
||||
$string['thislanguage'] = 'new language pack';<br />
|
||||
?>
|
||||
</code>
|
||||
|
||||
<br /><br />
|
||||
ou copiez le fichier <strong>moodle.php</strong> d'une autre langue dans votre nouveau dossier. Celui du dossier <strong>en</strong> est le plus actuel, mais peu importe puisque vous allez de toute façon le réécrire. Si vous choisissez de créer un nouveau fichier, vous aurez l'avantage de commencer avec des fichiers de langue complètement vides et propres.</p>
|
||||
|
||||
<p style="margin-left: 40px;">Vous êtes maintenant prêt à insérer les chaînes de caractères de votre langue ! Pour plus de détails voyez ci-dessous.</p>
|
||||
|
||||
@@ -74,31 +92,45 @@
|
||||
|
||||
<li>Vous pouvez laisser des chaînes vides. Moodle utilisera dans ce cas la chaîne de la langue mère (parentlanguage). si vous n'avez pas défini la langue mère dans le fichier <strong>moodle.php</strong>, l'anglais sera utilisé par défaut.</li>
|
||||
|
||||
<li>Une façon rapide de voir toutes les chaînes manquantes est de cliquer sur « Vérifier les textes manquant ».</li>
|
||||
<li>Une façon rapide de voir toutes les chaînes manquantes est de cliquer sur « Vérifier les textes manquants ». N'écrivez rien dans les chaînes qui n'ont pas (encore) de traduction, sans quoi cet outil si pratique ne fonctionnera plus à satisfaction.</li>
|
||||
|
||||
</ol>
|
||||
|
||||
<h3 style="margin-left: 40px;">Traduire les fichiers d'aide et la documentation</h3>
|
||||
|
||||
<p style="margin-left: 80px;">Il n'y a pas encore d'éditeur intégré dans Moodle pour traduire les fichiers d'aide et la documentation, mais ce n'est pas vraiment difficile. Il est important d'utiliser la langue <strong>en</strong> comme langue de référence. Copiez un fichier d'aide de ce dossier au même endroit dans votre propre dossier de langue. Utilisez ensuite un éditeur de texte pour modifier le fichier, en vous assurant de ne pas modifier le code qu'il contient (en général des balises HTML). N'UTILISEZ PAS UN TRAITEMENT DE TEXTE pour modifier ou écrire ces fichiers. Ces programmes les font grossir inutilement !</p>
|
||||
<p style="margin-left: 80px;">Il n'y a pas encore d'éditeur intégré dans Moodle pour traduire les fichiers d'aide et la documentation, mais ce n'est pas vraiment difficile. Il est important d'utiliser la langue <strong>en</strong> comme langue de référence. Copiez un fichier d'aide de ce dossier au même endroit dans votre propre dossier de langue. Utilisez ensuite un éditeur de texte pour modifier le fichier, en vous assurant de ne pas modifier le code qu'il contient (en général des balises HTML). N'UTILISEZ PAS UN TRAITEMENT DE TEXTE pour modifier ou écrire ces fichiers. Ces programmes les font grossir inutilement !
|
||||
<br />
|
||||
<strong>Ne laissez pas de chaînes non traduites dans vos fichiers de langue !</strong></p>
|
||||
|
||||
<p style="margin-left: 80px;">Prenez la peine d'écrire des fichiers d'aide en conformité avec la norme XHTML. Ceci comprend notamment les points suivants :</p>
|
||||
<ul style="margin-left: 80px;">
|
||||
<li>toutes les balises ouvertes doivent être fermées : <span style="color:rgb(255, 0, 0);" ><p></span>lalala<span style="color:rgb(255, 0, 0);" ></p></span></li>
|
||||
<li>tous les éléments doivent être correctement imbriqués : <span style="color:rgb(255, 0, 0);" ><p></span> lalala <span style="color:rgb(0, 0, 255);" ><em></span>lalala<span style="color:rgb(0, 0, 255);" ></em></span> <span style="color:rgb(255, 0, 0);" ></p></span></li>
|
||||
<li>tous les éléments et les attributs doivent être écrits en bas de casse (minuscules)</li>
|
||||
<li>tous les attributs doivent être écrits en totalité et entre guillemets droits : <span style="color:rgb(255, 0, 0);" ><p align="right"></span> lalala <span style="color:rgb(255, 0, 0);" ></p></span></li>
|
||||
<li>les éléments vides doivent être terminés par /> : <span style="color:rgb(255, 0, 0);" ><br /> <hr /></span>. Il faut mettre un espace avant le caractère « / ».</li>
|
||||
<li>chaque balise « img » doit comporter un attribut « alt » (qui peut être vide), par exemple <span style="color:rgb(255, 0, 0);" ><img alt src="photo.gif"></span></li>
|
||||
<li>les balises courtes du code PHP <span style="color:rgb(255, 0, 0);" ><?=</span> et <span style="color:rgb(255, 0, 0);" ><?</span> sont à retirer au profit de leur version normale <span style="color:rgb(255, 0, 0);" ><?php</span></li>
|
||||
<li>AUCUNE balise « font » ne doit figurer dans le code. Les balises <span style="color:rgb(255, 0, 0);" > <p> <em> <h1> <h2></span> etc. sont suffisantes pour les fichiers de langues</li>
|
||||
<li>le nom de la langue (indiqué dans la variable « $string['thislanguage'] » dans le fichier « moodle.php ») doit être dans la mesure du possible conforme au standard « Unicode Numeric Character References (NCR) », car ceci permet un affichage correct de ce nom dans TOUS les encodages (pour un exemple, voir la langue chinoise)</li>
|
||||
</ul>
|
||||
|
||||
<ul style="margin-left: 80px;">
|
||||
|
||||
<li>toutes les balises ouvertes doivent être fermées : <span style="color:rgb(255, 0, 0);" ><p></span>lalala<span style="color:rgb(255, 0, 0);" ></p></span></li>
|
||||
|
||||
<li>tous les éléments doivent être correctement imbriqués : <span style="color:rgb(255, 0, 0);" ><p></span> lalala <span style="color:rgb(0, 0, 255);" ><em></span>lalala<span style="color:rgb(0, 0, 255);" ></em></span> <span style="color:rgb(255, 0, 0);" ></p></span></li>
|
||||
|
||||
<li>tous les éléments et les attributs doivent être écrits en bas de casse (minuscules)</li>
|
||||
|
||||
<li>tous les attributs doivent être écrits en totalité et entre guillemets droits : <span style="color:rgb(255, 0, 0);" ><p align="right"></span> lalala <span style="color:rgb(255, 0, 0);" ></p></span></li>
|
||||
|
||||
<li>les éléments vides doivent être terminés par /> : <span style="color:rgb(255, 0, 0);" ><br /> <hr /></span>. Il faut mettre un espace avant le caractère « / ».</li>
|
||||
|
||||
<li>chaque balise « img » doit comporter un attribut « alt="" » (qui peut être vide) et doit en outre être fermé par un espace et />, par exemple <span style="color:rgb(255, 0, 0);" ><img alt="" src="photo.gif" /></span></li>
|
||||
|
||||
<li>les balises courtes du code PHP <span style="color:rgb(255, 0, 0);" ><?=</span> et <span style="color:rgb(255, 0, 0);" ><?</span> sont à retirer au profit de leur version normale <span style="color:rgb(255, 0, 0);" ><?php</span></li>
|
||||
|
||||
<li>AUCUNE balise « font » ne doit figurer dans le code. Les balises <span style="color:rgb(255, 0, 0);" > <p> <em> <h1> <h2></span> etc. sont suffisantes pour les fichiers de langues</li>
|
||||
|
||||
<li>le nom de la langue (indiqué dans la variable « $string['thislanguage'] » dans le fichier « moodle.php ») doit être dans la mesure du possible conforme au standard « Unicode Numeric Character References (NCR) », car ceci permet un affichage correct de ce nom dans TOUS les encodages (pour un exemple, voir la langue chinoise)</li>
|
||||
|
||||
</ul>
|
||||
|
||||
<p style="margin-left: 80px;">Aucun des fichiers du dossier « help » ne nécessite de description de document (doc type), ni des balises html, body, head (ouvrantes ou fermantes), car ces fichiers sont inclus à l'aide du fichier « help.php ». Le script se chargera de composer des pages formatées correctement. Cela signifie qu'il n'y a pas beaucoup d'opportunité de laisser libre cours à votre créativité ! Veuillez coller au plus près de l'exemple de la langue anglaise.</p>
|
||||
|
||||
<p style="margin-left: 80px;">Les fichiers du dossier « docs » doivent en revanche être en pleine conformité avec la norme XHTML, y compris la description de document (doc type), l'entête, etc.</p>
|
||||
|
||||
<p style="margin-left: 80px;">Si vous cliquez sur « Vérifier les textes manquant » dans la page d'administration des langues, une liste des fichiers manquant sera également affichée. En lieu et place des fichiers manquant, Moodle utilisera les fichiers de la langue mère (parentlanguage). Il n'est donc pas nécessaire de conserver des copies non traduites des fichiers d'aide dans votre dossier de langue.</p>
|
||||
<p style="margin-left: 80px;">Si vous cliquez sur « Vérifier les textes manquant » dans la page d'administration des langues, une liste des fichiers manquant sera également affichée. En lieu et place des fichiers manquant, Moodle utilisera les fichiers de la langue mère (parentlanguage). Il ne faut donc pas laisser des copies non traduites des fichiers d'aide dans votre dossier de langue, sinon cet outil si pratique ne fonctionnera plus à satisfaction.</p>
|
||||
|
||||
<h2>Offrir votre dossier de langue au projet Moodle</h2>
|
||||
|
||||
@@ -108,6 +140,28 @@
|
||||
|
||||
<p style="margin-left: 40px;">Nous vous communiquerons alors tous les détails nécessaires.</p>
|
||||
|
||||
<p style="margin-left: 40px;">Voici une liste de vérification à utiliser avant de proposer vos fichiers de langue :</p>
|
||||
|
||||
<ul type="circle" style="margin-left: 80px;">
|
||||
|
||||
<li>Aucun fichier vide ?</li>
|
||||
|
||||
<li>Aucun fichier ni aucune chaîne non traduite ?</li>
|
||||
|
||||
<li>Fichiers d'aide pas modifié avec un traitement de texte ?</li>
|
||||
|
||||
<li>Fichier README contenant une description de la langue, le nom et l'adresse de courriel du traducteur ?</li>
|
||||
|
||||
<li>Nom du dossier d'après le code de langue valable (vérification dans moodle\lib\languages.php) ?</li>
|
||||
|
||||
<li>Les fichiers de langue tournent sans erreur sur un Moodle de test ?</li>
|
||||
|
||||
<li>Lorsque la variable "thislanguage" contient des lettres avec diacritiques ou dans un autre alphabet que le romain, elle est écrite en notation NCR ?</li>
|
||||
|
||||
<li>Les chaînes et fichiers sont-ils conformes au format XHTML ?</li>
|
||||
|
||||
</ul>
|
||||
|
||||
<h2>Maintenance de fichiers de langue standard</h2>
|
||||
|
||||
<p style="margin-left: 40px;">Si vous vous êtes engagé dans la maintenance d'une langue dans Moodle, vous aurez intérêt à utiliser le <a href="?file=cvs.html">CVS de Moodle</a> afin d'avoir à disposition une version de Moodle toujours à jour et de pouvoir déposer vos modifications directement dans le projet Moodle.</p>
|
||||
|
||||
Reference in New Issue
Block a user