Ensuring compliance with XHTML Strict
Moodle uses the DocType XHTML Strict. We should take care to ensure our JavaScript maintains compliance with this standard.
Although it is best avoided, it may occasionally be necessary to include JavaScript code within <script>
tags that are embedded within the page. If this is the case, it is highly likely that the code will include characters that have special meaning to the XHTML Strict specification, for example &
and <', '>
to name a few.
Getting ready
Open the PHP file that contains the embedded JavaScript and locate the start and end <script>
tags.
How to do it...
Add the following code immediately after the opening <script>
tag:
<script language="JavaScript" type="text/javascript"> //<![CDATA[
Add the following code immediately before the closing <script>
tag:
//]]> </script>
How it works...
The CDATA
tag we have used informs the XHTML rendering engine that it should treat anything inside as arbitrary data, and not to attempt to parse it as if it were valid XHTML markup.
Additionally, to avoid a conflict with JavaScript syntax, the lines on which the CDATA
tags reside have been commented out with double forward slashes (//).