[MKDoc-commit] Added some documentation.

[chris at mkdoc.demon.co.uk]

Log Message:
-----------
Added some documentation.

Modified Files:
--------------
    mkd/resources/templates/component/file:
        en.html

-------------- next part --------------
Index: en.html
===================================================================
RCS file: /var/spool/cvs/mkd/resources/templates/component/file/en.html,v
retrieving revision 1.5
retrieving revision 1.6
diff -Lresources/templates/component/file/en.html -Lresources/templates/component/file/en.html -u -r1.5 -r1.6
--- resources/templates/component/file/en.html
+++ resources/templates/component/file/en.html
@@ -1,7 +1,47 @@
 <!--?
 
+  File Component Template
+  =======================
+
+  This template is used for rendering file components in documents. 
+
+  It will only display is the file name doesn't match one oif the 
+  special file names that are set not to display, these are:
+
+  - style.css this is for user uploaded CSS
+
+  - favicon.ico this is for bookmarks
+
+  - logo.png this is the the logo of the site, it needs to be appached
+    to the front page of the site.
+
+  - script.js this is for user uploaded javascript.
+
+  A class is set that contains the file extendion of the file so that
+  icons can be added using CSS.
+
+  $Id$
+
+
+  Author: Jean-Michel Hiver, Chris Croome <chris at webarchitects.co.uk>, and others
+  Copyright: (c) 2004, MKDoc Holdings Ltd.
+
+  This file is part of MKDoc. 
+  
+  MKDoc is free software; you can redistribute it and/or modify
+  it under the terms of the GNU General Public License as published by
+  the Free Software Foundation; either version 2 of the License, or
+  (at your option) any later version.
+  
+  MKDoc is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  GNU General Public License for more details.
+  
+  You should have received a copy of the GNU General Public License
+  along with MKDoc; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
-This template is used for rendering file components in documents. 
 
 ?-->
 <div 
@@ -12,11 +52,14 @@
   xmlns:petal="http://purl.org/petal/1.0/"
   class="component-file"
 >
-<!-- ; false: self/name_is - -favicon.ico" -->
-  <p petal:attributes="class string:file-${self/extension}"
-     class="file-ext">
-    <a href="#"
-       petal:content="self/title"
-       petal:attributes="href self/uri">wonderful-file.txt</a>
+  <p 
+    class="file-ext"
+    petal:attributes="class string:file-${self/extension}"
+  >
+    <a 
+      href="#"
+      petal:content="self/title"
+      petal:attributes="href self/uri"
+    >wonderful-file.txt</a>
   </p>
 </div>