From 6d90a9d53104e185303895b40927ce44be87edcb Mon Sep 17 00:00:00 2001
From: David Faure <faure@kde.org>
Date: Fri, 4 Apr 2014 00:16:21 +0200
Subject: desktop-entry-spec: define "desktop ID"

(was only in menu spec; moved and improved)

As requested and reviewed by Ryan Lortie, also reviewed by Bastien Nocera.
---
 desktop-entry/desktop-entry-spec.xml | 44 ++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

(limited to 'desktop-entry')

diff --git a/desktop-entry/desktop-entry-spec.xml b/desktop-entry/desktop-entry-spec.xml
index 1f02d95..d3879f2 100644
--- a/desktop-entry/desktop-entry-spec.xml
+++ b/desktop-entry/desktop-entry-spec.xml
@@ -61,6 +61,15 @@
           </address>
         </affiliation>
       </author>
+      <author>
+        <firstname>David</firstname>
+        <surname>Faure</surname>
+        <affiliation>
+          <address>
+            <email>faure@kde.org</email>
+          </address>
+        </affiliation>
+      </author>
     </authorgroup>
   </articleinfo>
 
@@ -1475,4 +1484,39 @@ Icon=fooview-new
       the name as it appears in the "Encoding" column above.
     </para>
   </appendix>
+  <appendix id="desktop-file-id">
+    <title>Desktop File ID</title>
+    <para>
+        The desktop file ID is the identifier of an installed desktop entry file.
+    </para>
+    <para>
+        To determine the ID of a desktop file, make its full path relative to
+        the <literal>$XDG_DATA_DIRS</literal> component in which the desktop file is installed, remove the "applications/"
+        prefix, and turn '/' into '-'.
+     </para>
+     <para>
+        For example <filename>/usr/share/applications/foo/bar.desktop</filename> has
+        the desktop file ID <literal>foo-bar.desktop</literal>.
+     </para>
+     <para>
+        If multiple files have the same desktop file ID, the first one in the
+        $XDG_DATA_DIRS precedence order is used.
+     </para>
+     <para>
+        For example, if <literal>$XDG_DATA_DIRS</literal> contains the default paths /usr/local/share:/usr/share, then
+        <filename>/usr/local/share/applications/org.foo.bar.desktop</filename> and
+        <filename>/usr/share/applications/org.foo.bar.desktop</filename> both have
+        the same desktop file ID <literal>org.foo.bar.desktop</literal>, but only the first
+        one will be used.
+     </para>
+     <para>
+        If both <filename>foo-bar.desktop</filename> and <filename>foo/bar.desktop</filename> exist,
+        it is undefined which is selected.
+     </para>
+     <para>
+        If the desktop file is not installed in an <literal>applications</literal> subdirectory of one
+        of the $XDG_DATA_DIRS components, it does not have an ID.
+     </para>
+  </appendix>
+
 </article>
-- 
cgit v1.2.3-70-g09d2