From: koenr
Date: Wed, 12 Jan 2005 09:53:15 +0000 (+0000)
Subject: Updated translationguide.html, learning from the errors I've seen when making the...
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=491f47f4248fbda6c779e1e894dab61a2de5c251;p=moodle.git
Updated translationguide.html, learning from the errors I've seen when making the language packs XHTML compliant.
Please check the modification for errors to content and english language before I anounce this modification in the language forum!!
---
diff --git a/lang/en/docs/translation.html b/lang/en/docs/translation.html
index 1601959d64..3b9ace0c8a 100755
--- a/lang/en/docs/translation.html
+++ b/lang/en/docs/translation.html
@@ -167,6 +167,21 @@ making sure not to modify any code in the file (there usually is no
code, just HTML-tags). (DON'T USE A WORDPROCESSOR to write the
help-files because these programs add too much rubbish to the files).
+Take care to write the helpfiles XHTML-compliant. This means in short:
+
+ - All tags should be closed: <p>lalala</p>
+ - All elements should be nested: <p> lalala <em>lalala</em> </p>
+ - All elements and attributes must be lower case
+ - All atributes should be written in full and with quotes : <p align="right"> lalala </p>
+ - Empty elements must end with />: <br /> <hr />. You should add an extra space before the "/" symbol.
+ - An <img should have an alt (it can be empty) like <img alt src="picture.gif">
+ - <?= and <? should be <?php
+ - There should not be ANY font tags at all. <p><em> <h1> <h2> etc should be enough for the language files ...
+ - The language name in the languagepack ($string['thislanguage'] in moodle.php) should generally use Unicode Numeric Character References (NCR) if possible, because this allows the name to work within ANY encoding context (see the Chinese pack for example).
+
+None of the files in the help folder need a doc type, html, body, head opening and closing tags - these files are included with help.php. The script will take care of welforming the pages. This means also there is not much room for HTML creativity! Please stick to the English example.
+The files in the docs folder must be completely XHTML compliant, including doc type, header etc.
+
Clicking on "Check for missing strings"
in the language administration screen will also show you what files you