[gnome-devel-docs/wip/kill-integration-guide: 2/2] WIP move integration guide topics into platform overview
- From: David King <davidk src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-devel-docs/wip/kill-integration-guide: 2/2] WIP move integration guide topics into platform overview
- Date: Tue, 28 Jan 2014 13:26:15 +0000 (UTC)
commit 6c87fb025d8acca62e0c36a44b542f932eb340aa
Author: David King <amigadave amigadave com>
Date: Mon Jan 27 18:59:12 2014 +0000
WIP move integration guide topics into platform overview
platform-overview/C/dev-launching-desktop.page | 73 ++++++++++++++++++++++++
platform-overview/C/dev-launching-icons.page | 37 ++++++++++++
platform-overview/C/dev-launching-mime.page | 32 ++++++++++
platform-overview/C/dev-launching.page | 35 +++++++++++
platform-overview/C/index.page | 2 +-
platform-overview/Makefile.am | 4 +
6 files changed, 182 insertions(+), 1 deletions(-)
---
diff --git a/platform-overview/C/dev-launching-desktop.page b/platform-overview/C/dev-launching-desktop.page
new file mode 100644
index 0000000..fd43db1
--- /dev/null
+++ b/platform-overview/C/dev-launching-desktop.page
@@ -0,0 +1,73 @@
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:its="http://www.w3.org/2005/11/its"
+ type="topic" style="task"
+ id="dev-launching-desktop">
+
+ <info>
+ <link type="next" xref="dev-launching-icons"/>
+ <revision version="0.1" date="2014-01-27" status="draft"/>
+
+ <credit type="author">
+ <name>David King</name>
+ <email its:translate="no">davidk gnome org</email>
+ <years>2014</years>
+ </credit>
+
+ <include href="cc-by-sa-3-0.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+ </info>
+
+ <title>Install a desktop file</title>
+
+ <links type="series" style="floatend">
+ <title>Launch your application</title>
+ </links>
+
+ <p>Write and install a desktop file so that users can discover and launch
+ your application.</p>
+
+ <p>GNOME uses the freedesktop.org Desktop Entry and Desktop Menu
+ specifications to describe application launchers. Installing a desktop file
+ is the standard way to register your application with GNOME and other
+ desktops.</p>
+
+ <p>A desktop file lists your application binary, name and type, and can also
+ list an icon, description and several other pieces of information about
+ launching an application.</p>
+
+ <p>For a hypothetical application <app>My Application</app>, a desktop file
+ would look as follows:</p>
+ <example>
+ <listing>
+ <title><file>myapplication.desktop</file></title>
+<code>[Desktop Entry]
+Name=My Application
+Exec=myapplication
+Type=Application
+Icon=myapplication
+Comment=Do the thing that the application does
+Categories=GTK;GNOME;Utility;</code>
+ </listing>
+ </example>
+
+ <p>The <code>[Desktop Entry]</code> line indicates that this is a desktop
+ file. It is followed by keys, which describe the application launcher. The
+ <code>Name</code> key is the human-readable name of the application, to be
+ shown in the UI. The application binary is listed in the <code>Exec</code>
+ key, either the complete path or a binary that is looked up in the
+ <code>PATH</code>. The last required key is the <code>Type</code>, which for
+ applications is always <code>Application</code>. Alternative types are listed
+ in the desktop entry specification.</p>
+
+ <p>Other fields in the desktop file are optional, but recommended.
+ Applications should install an icon, and list the name of the icon (excluding
+ the extension) in the <code>Icon</code> key. The <code>Comment</code> is a
+ brief description of the application. To help users when browsing
+ applications, the <code>Categories</code> key should be populated with a
+ list of categories, separated by a semicolon, from the Desktop Menu
+ Specification.</p>
+
+ <p>There are several other keys that can be added to desktop files, which are
+ listed and described in the Desktop Entry Specification.</p>
+
+</page>
diff --git a/platform-overview/C/dev-launching-icons.page b/platform-overview/C/dev-launching-icons.page
new file mode 100644
index 0000000..95f2a0b
--- /dev/null
+++ b/platform-overview/C/dev-launching-icons.page
@@ -0,0 +1,37 @@
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:its="http://www.w3.org/2005/11/its"
+ type="topic" style="task"
+ id="dev-launching-icons">
+
+ <info>
+ <link type="next" xref="dev-launching-mime"/>
+ <revision version="0.1" date="2014-01-27" status="draft"/>
+
+ <credit type="author">
+ <name>David King</name>
+ <email its:translate="no">davidk gnome org</email>
+ <years>2014</years>
+ </credit>
+
+ <include href="cc-by-sa-3-0.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+ </info>
+
+ <title>Install an icon</title>
+
+ <links type="series" style="floatend">
+ <title>Launch your application</title>
+ </links>
+
+ <p>Install an icon to identify your application.</p>
+
+ <p>When listing an icon in a desktop file, the image must be installed in a
+ standard location, given by the freedesktop.org Icon Theme and Icon Naming
+ specifications. As a minimum, an application should install a 48×48 pixel
+ icon into <file><var>$prefix</var>/share/icons/hicolor/48x48/apps</file> in
+ PNG format.</p>
+
+ <p>To match with other icons, both in GNOME and other platforms, follow the
+ Tango guidelines when creating icons and application artwork.</p>
+
+</page>
diff --git a/platform-overview/C/dev-launching-mime.page b/platform-overview/C/dev-launching-mime.page
new file mode 100644
index 0000000..d164384
--- /dev/null
+++ b/platform-overview/C/dev-launching-mime.page
@@ -0,0 +1,32 @@
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:its="http://www.w3.org/2005/11/its"
+ type="topic" style="task"
+ id="dev-launching-mime">
+
+ <info>
+ <link type="seealso" xref="dev-launching"/>
+ <revision version="0.1" date="2014-01-28" status="draft"/>
+
+ <credit type="author">
+ <name>David King</name>
+ <email its:translate="no">davidk gnome org</email>
+ <years>2014</years>
+ </credit>
+
+ <include href="cc-by-sa-3-0.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+ </info>
+
+ <title>Associate MIME types</title>
+
+ <links type="series" style="floatend">
+ <title>Launch your application</title>
+ </links>
+
+ <p>Associate files with your application, using MIME types.</p>
+
+ <p>If your application opens files of a certain type, such as PNG images, you
+ can add an association with the MIME type of the file. This is added to the
+ desktop file.</p>
+
+</page>
diff --git a/platform-overview/C/dev-launching.page b/platform-overview/C/dev-launching.page
new file mode 100644
index 0000000..440cc6c
--- /dev/null
+++ b/platform-overview/C/dev-launching.page
@@ -0,0 +1,35 @@
+<page xmlns="http://projectmallard.org/1.0/"
+ xmlns:its="http://www.w3.org/2005/11/its"
+ type="topic" style="task"
+ id="dev-launching">
+
+ <info>
+ <link type="guide" xref="index" group="launching"/>
+ <link type="next" xref="dev-launching-desktop"/>
+ <link type="seealso" xref="dev-translate"/>
+
+ <revision version="0.1" date="2014-01-27" status="draft"/>
+
+ <credit type="author copyright">
+ <name>David King</name>
+ <email its:translate="no">davidk gnome org</email>
+ <years>2014</years>
+ </credit>
+
+ <include href="cc-by-sa-3-0.xml" xmlns="http://www.w3.org/2001/XInclude"/>
+
+ <desc>Showing a launcher and starting your application.</desc>
+
+ </info>
+
+ <title>Application launching</title>
+
+ <links type="series" style="floatend">
+ <title>Launch your application</title>
+ </links>
+
+ <p>An icon in the launcher is the standard way to launch your application.
+ Use the freedesktop.org Desktop Entry Specification standard to create a
+ desktop file, giving your application name, icon and a brief description.</p>
+
+</page>
diff --git a/platform-overview/C/index.page b/platform-overview/C/index.page
index 37b3854..193ebba 100644
--- a/platform-overview/C/index.page
+++ b/platform-overview/C/index.page
@@ -62,7 +62,7 @@
<links type="topic" style="2column" groups="#first ui"/>
</section>-->
- <links type="topic" style="grid center" groups="help translate">
+ <links type="topic" style="grid center" groups="launching help translate">
<title style="heading">Integration guides</title>
</links>
diff --git a/platform-overview/Makefile.am b/platform-overview/Makefile.am
index 5f66d83..6b78893 100644
--- a/platform-overview/Makefile.am
+++ b/platform-overview/Makefile.am
@@ -8,6 +8,10 @@ HELP_FILES = \
dev-help-build.page \
dev-help.page \
dev-help-write.page \
+ dev-launching-desktop.page \
+ dev-launching-icons.page \
+ dev-launching-mime.page \
+ dev-launching.page \
dev-translate-build.page \
dev-translate.page \
dev-translate-setup.page \
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]