From 1ac1ccdd974b3f42508a93d51d074ad3d8ce1dbf Mon Sep 17 00:00:00 2001
From: "bzbarsky%mit.edu" <bzbarsky%mit.edu>
Date: Fri, 24 Jan 2003 00:46:11 +0000
Subject: [PATCH] Document the various fields in mimeTypes.rdf.  Bug 61408,
 r=timeless, sr=mozbot, rubber-a=roc+moz

---
 profile/defaults/mimeTypes.rdf        | 61 ++++++++++++++++++++++++---
 uriloader/exthandler/nsHelperAppRDF.h |  1 +
 2 files changed, 56 insertions(+), 6 deletions(-)

diff --git a/profile/defaults/mimeTypes.rdf b/profile/defaults/mimeTypes.rdf
index 1d68511efee1..a25429da93c6 100644
--- a/profile/defaults/mimeTypes.rdf
+++ b/profile/defaults/mimeTypes.rdf
@@ -1,11 +1,60 @@
 <?xml version="1.0"?>  
 
-<RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:NC="http://home.netscape.com/NC-rdf#">
+<!--
+ This file is used as a persistent data store for helper application
+ information.
 
-  <Description about="urn:mimetypes"> 
+ The root of the data is the <RDF:Seq about="urn:mimetypes:root"/>. This
+ contains one <RDF:li/> entry per MIME type.  Each <RDF:li/> entry corresponds
+ to the "urn:mimetype:major/minor" resource, where "major/minor" is the MIME
+ type.  For example, for HTML we would have "urn:mimetype:text/html".
+ Typically, this resource will be in the <RDF:Description/> node which has the
+ corresponding "about" attribute.
+
+ Each "urn:mimetype:major/minor" resource can have the following properties:
+
+   NC:Value - the MIME type string
+   NC:editable - a "true" or "false" depending on whether this entry is
+                 editable
+   NC:description - a description of the type ("HTML Document" for text/html)
+   NC:fileExtensions - there will be one of these properties per extension that
+                       corresponds to this MIME type, each one having a single
+                       extension as its value.
+   NC:handlerProp - the way the type should be handled.  This corresponds to a
+                    "urn:mimetype:handler:major/minor" resource.  Eg, the way
+                    HTML is handled would be stored in the
+                    "urn:mimetype:handler:text/html" resource
+
+ Each "urn:mimetype:handler:major/minor" resource can have the following
+ properties:
+
+   NC:useSystemDefault - "true" if we should handle per default OS setting,
+                          "false" or not set otherwise
+   NC:saveToDisk - "true" if the data should be saved to disk, "false" or not
+                   set otherwise.
+     (Note - if both of these are false, that means "open in helper app")
+   NC:alwaysAsk - "true" if the user should always be prompted before handling
+                  data of this type, false otherwise.
+   NC:externalApplication - the helper application to use for this type.  This
+                            corresponds to a
+                            "urn:mimetype:externalApplication:major/minor"
+			    resource
+
+ Each "urn:mimetype:externalApplication:major/minor" resource can have the
+ following properties:
+
+   NC:path - the path to the application
+   NC:prettyName - the "pretty name" of the application ("Acrobat Reader" for
+                   /usr/bin/acroread, eg).
+-->
+			
+<RDF:RDF xmlns:RDF="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+         xmlns:NC="http://home.netscape.com/NC-rdf#">
+
+  <RDF:Description about="urn:mimetypes"> 
     <NC:MIME-types> 
-	    <Seq about="urn:mimetypes:root"> 
-	    </Seq> 
+      <RDF:Seq about="urn:mimetypes:root"> 
+      </RDF:Seq>
     </NC:MIME-types> 
-  </Description> 
-</RDF>
+  </RDF:Description> 
+</RDF:RDF>
diff --git a/uriloader/exthandler/nsHelperAppRDF.h b/uriloader/exthandler/nsHelperAppRDF.h
index 91e2c593bf78..c8db9c6a4ea3 100644
--- a/uriloader/exthandler/nsHelperAppRDF.h
+++ b/uriloader/exthandler/nsHelperAppRDF.h
@@ -39,6 +39,7 @@
 // app data source. The helper app data source contains user specified helper
 // application override information.
 
+// See profile/defaults/mimeTypes.rdf for documentation on these properties
 
 #define NC_RDF_MIMETYPES				NC_NAMESPACE_URI"MIME-Types"
 // a mime type has the following properties...