[gnome-devel-docs/wip/reorganization] update the desktop file tutorial
- From: Allan Day <allanday src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-devel-docs/wip/reorganization] update the desktop file tutorial
- Date: Wed, 27 Feb 2013 13:06:25 +0000 (UTC)
commit 6ef70076d56e5a3cedf75ef7e72aa47997083c3b
Author: Allan Day <allanpday gmail com>
Date: Wed Feb 27 13:03:32 2013 +0000
update the desktop file tutorial
tutorials/C/desktop-files.page | 70 +++++++++++++++--------------
tutorials/C/samples/helloWorld.desktop.in | 11 -----
2 files changed, 36 insertions(+), 45 deletions(-)
---
diff --git a/tutorials/C/desktop-files.page b/tutorials/C/desktop-files.page
index 81d5934..b865d9c 100644
--- a/tutorials/C/desktop-files.page
+++ b/tutorials/C/desktop-files.page
@@ -4,50 +4,52 @@
type="guide" style="task"
id="desktop-files">
- <info>
+<info>
<title type="text">Desktop Files</title>
- <link type="guide" xref="integration#integration"/>
+ <link type="guide" xref="integration#integration"/>
- <revision version="0.1" date="2012-02-19" status="stub"/>
+ <revision version="0.1" date="2012-02-19" status="stub"/>
- <credit type="author copyright">
- <name>Susanna Huhtanen</name>
- <email>ihmis suski gmail com</email>
- <years>2012</years>
- </credit>
- <credit type="editor">
- <name>Tiffany Antopolski</name>
- <email>tiffany antopolski gmail com</email>
- </credit>
+ <credit type="author copyright">
+ <name>Susanna Huhtanen</name>
+ <email>ihmis suski gmail com</email>
+ <years>2012</years>
+ </credit>
+ <credit type="author copyright">
+ <name>Allan Day</name>
+ <email>allanday gnome org</email>
+ <years>2013</years>
+ </credit>
+ <credit type="editor">
+ <name>Tiffany Antopolski</name>
+ <email>tiffany antopolski gmail com</email>
+ </credit>
- <desc>How to use the desktop file</desc>
- </info>
+ <desc>How to use the desktop file</desc>
+</info>
- <title>The Desktop File</title>
+<title>The Desktop File</title>
- <section id="desktop.in">
- <title>The <file>.desktop.in</file> file</title>
- <p>Running applications from the Terminal is useful at the beginning of the application making process.
To have fully working <link href=
"http://library.gnome.org/admin/system-admin-guide/stable/mimetypes-9.html.en">application integration</link>
in GNOME 3 requires a desktop launcher. For this you need to create a <file>.desktop</file> file. The
<file>.desktop</file> file describes the application name, the used icon and various integration bits. A
deeper insight into the <file>.desktop</file> file can be found <link href=
"http://developer.gnome.org/desktop-entry-spec/">here</link>. The <file>.desktop.in</file> file will create
the <file>.desktop</file>.</p>
+<p>The <file>.desktop.in</file> file is an essential part of integrating your application. It provides GNOME
3 with information about your application, such as its name and application icon, and is used to generate a
launcher for your application inside the Activities Overview.</p>
- <note>
- <p>Before continuing, resave <file>helloWorld.js</file> as <file>helloWorld</file>. Then run this in
the command line:</p>
- <screen><output style="prompt">$ </output><input>chmod +x helloWorld</input></screen>
- </note>
+<p>Desktop files follow a simple key value format. The following desktop file is for an imaginary image
gallery application. It indicates what should be included in your <file>.desktop.in</file> file.</p>
- <p>The example shows you the minimum requirements for a <code>.desktop.in</code> file.</p>
- <code mime="text/desktop" style="numbered"><xi:include href="samples/helloWorld.desktop.in"
parse="text"><xi:fallback/></xi:include></code>
+<code mime="text/desktop" style="numbered"><xi:include href="samples/desktop.in"
parse="text"><xi:fallback/></xi:include></code>
- <p>Now let's go through some parts of the <code>.desktop.in</code> file.</p>
- <terms>
- <item><title>Name</title><p>The application name.</p></item>
- <item><title>Comment</title><p>A short description of the application.</p></item>
- <item><title>Exec</title><p>Specifies a command to execute when you choose the application from the
menu. In this example exec just tells where to find the <file>helloWorld</file> file and the file takes care
of the rest.</p></item>
- <item><title>Terminal</title><p>Specifies whether the command in the Exec key runs in a terminal
window.</p></item>
- </terms>
+<p>Some items in the desktop file, such as <code>Version</code>, <code>Encoding</code>,
<code>Terminal</code>, <code>Type</code>, and <code>StartupNotify</code> should not be modified. The other
entries should be updated to reflect your particular application.</p>
- <p>To put your application into the appropriate category, you need to add the necessary categories to
the Categories line. More information on the different categories can be found in the <link href =
"http://standards.freedesktop.org/menu-spec/latest/apa.html">menu specification</link>.</p>
- <p>In this example we use an existing icon. For a custom icon you need to have a .svg file of your icon,
stored in <file>/usr/share/icons/hicolor/scalable/apps</file>. Write the name of your icon file to the
.desktop.in file, on line 7. More information on icons in: <link
href="http://library.gnome.org/admin/system-admin-guide/stable/themes-11.html.en"> Installing Icons for
Themes </link>, <link href="https://live.gnome.org/GnomeGoals/AppIcon">Installing Icons for Themes</link> and
<link href="http://freedesktop.org/wiki/Specifications/icon-theme-spec">on freedesktop.org:
Specifications/icon-theme-spec</link>.</p>
+<terms>
+ <item><title>Name</title><p>The application name.</p></item>
+ <item><title>Comment</title><p>A short description of the application.</p></item>
+ <item><title>Exec</title><p>Specifies the command to run the application.</p></item>
+ <item><title>Icon</title><p>The file name of your application icon.</p></item>
+ <item><title>Terminal</title><p>Specifies whether the command in the Exec key runs in a terminal
window.</p></item>
+ <item><title>Categories</title><p>What do we use these for nowadays, anyway?</p></item>
+ <item><title>Keywords</title><p>These are used in GNOME 3's integrated search.</p></item>
+</terms>
- </section>
+<p>Your desktop file should be located in the data directory of your application directory.</p>
+
+ <p>To put your application into the appropriate category, you need to add the necessary categories to the
Categories line. More information on the different categories can be found in the <link href =
"http://standards.freedesktop.org/menu-spec/latest/apa.html">menu specification</link>.</p>
</page>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]