[maemo-commits] [maemo-commits] r10530 - in projects/haf/trunk/libhildonmime: . docs

From: subversion at stage.maemo.org subversion at stage.maemo.org
Date: Tue Mar 13 15:08:13 EET 2007
Author: martyn
Date: 2007-03-13 15:08:11 +0200 (Tue, 13 Mar 2007)
New Revision: 10530

Added:
   projects/haf/trunk/libhildonmime/docs/osso-uri-open.txt
Modified:
   projects/haf/trunk/libhildonmime/ChangeLog
   projects/haf/trunk/libhildonmime/docs/hildon-uri-open.txt
   projects/haf/trunk/libhildonmime/docs/mime-category-mapping.txt
   projects/haf/trunk/libhildonmime/docs/mime-dbus-mapping.txt
Log:
	* docs/osso-uri-open.txt: Separated the desktop file changes out
	from the mime-dbus-mapping.txt file so we have a file to link to
	in the hildon-uri-open.txt documentation.

	* docs/hildon-uri-open.txt: Mention that the desktop entry
	specification and the old API we used in osso-uri-open.txt.

	* docs/mime-category-mapping.txt: 
	* docs/mime-dbus-mapping.txt: Clean up, and give better URIs to
	the freedesktop specifications.


Modified: projects/haf/trunk/libhildonmime/ChangeLog
===================================================================
--- projects/haf/trunk/libhildonmime/ChangeLog	2007-03-13 13:08:10 UTC (rev 10529)
+++ projects/haf/trunk/libhildonmime/ChangeLog	2007-03-13 13:08:11 UTC (rev 10530)
@@ -1,3 +1,16 @@
+2007-03-13  Martyn Russell  <martyn at imendio.com>
+
+	* docs/osso-uri-open.txt: Separated the desktop file changes out
+	from the mime-dbus-mapping.txt file so we have a file to link to
+	in the hildon-uri-open.txt documentation.
+	
+	* docs/hildon-uri-open.txt: Mention that the desktop entry
+	specification and the old API we used in osso-uri-open.txt.
+	
+	* docs/mime-category-mapping.txt: 
+	* docs/mime-dbus-mapping.txt: Clean up, and give better URIs to
+	the freedesktop specifications.
+
 2007-03-12  Martyn Russell  <martyn at imendio.com>
 
 	* docs/hildon-uri-open.txt: Clarify a few issues in the

Modified: projects/haf/trunk/libhildonmime/docs/hildon-uri-open.txt
===================================================================
--- projects/haf/trunk/libhildonmime/docs/hildon-uri-open.txt	2007-03-13 13:08:10 UTC (rev 10529)
+++ projects/haf/trunk/libhildonmime/docs/hildon-uri-open.txt	2007-03-13 13:08:11 UTC (rev 10530)
@@ -1,16 +1,34 @@
 MIME/URI handling
 =================
 
+Preamble
+========
+
+Before reading this, you should make sure you are full aqainted with
+the desktop entry standard which libhildonmime builds on top of. This
+can be found here:
+
+  http://standards.freedesktop.org/desktop-entry-spec/latest/
+
+
 Background
 ==========
 
+This version of the framework has changed largely in API and the way
+that the desktop files are designed. There is an example of the old
+desktop file format (which is still supported) below but to understand
+it completely, you would be advised to read the original specification
+found here: 
+
+      libhildonmime/docs/osso-uri-open.txt
+
 The previous framework only had a way to handle URIs based on the scheme,
 not MIME type. One application would handle callto:// URIs, one http://, 
 etc.
 
-The libhildonmime code has been extended to add support for mapping the
-scheme & MIME type pair to an action. Each application can implement one or
-more actions.
+Now, libhildonmime has been extended to add support for mapping the
+scheme & MIME type pair to an action. Each application can implement
+one or more actions.
 
 
 Desktop file format

Modified: projects/haf/trunk/libhildonmime/docs/mime-category-mapping.txt
===================================================================
--- projects/haf/trunk/libhildonmime/docs/mime-category-mapping.txt	2007-03-13 13:08:10 UTC (rev 10529)
+++ projects/haf/trunk/libhildonmime/docs/mime-category-mapping.txt	2007-03-13 13:08:11 UTC (rev 10530)
@@ -1,13 +1,19 @@
 MIME/Category Mapping
 =====================
 
-Note: This document assumes familiarity with adding MIME types to the
-system, using the shared-mime-info specification. The specification can
-be found at:
+Preamble
+========
 
-  http://standards.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-0.13.html
+This document assumes familiarity with adding MIME types to the
+system, using the shared-mime-info specification. This specification
+can be found at:
 
+  http://standards.freedesktop.org/shared-mime-info-spec/latest/
 
+
+Categories
+==========
+
 The platform has a notion of file categories for the user's data
 files. The available categories are:
 
@@ -33,7 +39,7 @@
 
 
 Adding mappings
----------------
+===============
 
 Adding a mapping between a category and a number of MIME types is done
 much like adding or editing the supported MIME types in the system.

Modified: projects/haf/trunk/libhildonmime/docs/mime-dbus-mapping.txt
===================================================================
--- projects/haf/trunk/libhildonmime/docs/mime-dbus-mapping.txt	2007-03-13 13:08:10 UTC (rev 10529)
+++ projects/haf/trunk/libhildonmime/docs/mime-dbus-mapping.txt	2007-03-13 13:08:11 UTC (rev 10530)
@@ -1,12 +1,25 @@
 MIME/DBus Service Mapping
 =========================
 
-Note: This document assumes familiarity with adding MIME types to the
-system, using the shared-mime-info specification. The specification
+Preamble
+========
+
+Before reading this, you should make sure you are full aqainted with
+the desktop entry standard which libhildonmime builds on top of. This
+can be found here:
+
+  http://standards.freedesktop.org/desktop-entry-spec/latest/
+
+Also, this document assumes familiarity with adding MIME types to the
+system, using the shared-mime-info specification. This specification
 can be found at:
 
-  http://standards.freedesktop.org/shared-mime-info-spec/shared-mime-info-spec-0.13.html 
+  http://standards.freedesktop.org/shared-mime-info-spec/latest/
 
+
+Commands
+========
+
 There are 2 different utilities used when it comes to the MIME
 database/desktop files:
 
@@ -14,38 +27,8 @@
   * update-mime-datebase:
 
 
-Desktop files
--------------
-
-These are found in $prefix/share/applications. Each application has a
-desktop file, that specifies how it is started, what name it has,
-etc. It also specifies which MIME types the application can handle, if
-any.
-
-The desktop file standard can be found here:
-
-  http://www.freedesktop.org/wiki/Standards_2fdesktop_2dentry_2dspec 
-
-In Maemo, the ONLY addition to the standard for .desktop files is the
-'X-Osso-Service' key. This identifies the DBus service to to talk to
-when trying to open a URI.
-
-When the osso_mime_open_*() API is called with a URI, GnomeVFS is used
-to get the default MIME type if there is one, and otherwise the first
-from the list of possible ones for the specified MIME type is used.
-
-Then a DBus message is sent to activate the service specified by the
-'X-Osso-Service' value, and the URI is passed to it for opening.
-
-The 'MimeType' key which is part of the standard is used by GnomeVFS
-to find out which desktop file it should return for us to look up the
-'X-Osso-Service' key in.  Note, the 'MimeType' value is a semi-colon
-separated list of types, for example 'image/png;image/jpeg;'. Note the
-trailing semi-colon.
-
-
 Updating the Desktop Database
------------------------------
+=============================
 
 The 'update-desktop-database' command looks at *.desktop file anywhere below:
 

Added: projects/haf/trunk/libhildonmime/docs/osso-uri-open.txt
===================================================================
--- projects/haf/trunk/libhildonmime/docs/osso-uri-open.txt	2007-03-13 13:08:10 UTC (rev 10529)
+++ projects/haf/trunk/libhildonmime/docs/osso-uri-open.txt	2007-03-13 13:08:11 UTC (rev 10530)
@@ -0,0 +1,37 @@
+Desktop files in libossomime
+============================
+
+Preamble
+========
+
+Before reading this, you should make sure you are full aqainted with
+the desktop entry standard which libhildonmime builds on top of. This
+can be found here:
+
+  http://standards.freedesktop.org/desktop-entry-spec/latest/
+
+
+Desktop file format
+===================
+
+These are found in $prefix/share/applications. Each application has a
+desktop file, that specifies how it is started, what name it has,
+etc. It also specifies which MIME types the application can handle, if
+any.
+
+In Maemo, the ONLY addition to the standard for .desktop files is the
+'X-Osso-Service' key. This identifies the DBus service to to talk to
+when trying to open a URI.
+
+When the osso_mime_open_*() API is called with a URI, GnomeVFS is used
+to get the default MIME type if there is one, and otherwise the first
+from the list of possible ones for the specified MIME type is used.
+
+Then a DBus message is sent to activate the service specified by the
+'X-Osso-Service' value, and the URI is passed to it for opening.
+
+The 'MimeType' key which is part of the standard is used by GnomeVFS
+to find out which desktop file it should return for us to look up the
+'X-Osso-Service' key in.  Note, the 'MimeType' value is a semi-colon
+separated list of types, for example 'image/png;image/jpeg;'. Note the
+trailing semi-colon.


More information about the maemo-commits mailing list