summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRyan Rix <phrkonaleash@gmail.com>2009-12-03 13:40:57 -0700
committerRyan Rix <phrkonaleash@gmail.com>2009-12-03 13:40:57 -0700
commit4a1e583d8e5c56eeb46760d621e640884f2038fa (patch)
tree763b5a2f3c3d379e3bae86a04c972e877268deed
downloadfedora-tour-4a1e583d8e5c56eeb46760d621e640884f2038fa.tar.gz
fedora-tour-4a1e583d8e5c56eeb46760d621e640884f2038fa.tar.xz
fedora-tour-4a1e583d8e5c56eeb46760d621e640884f2038fa.zip
Initial commit
-rw-r--r--BACKEND40
1 files changed, 40 insertions, 0 deletions
diff --git a/BACKEND b/BACKEND
new file mode 100644
index 0000000..587e90b
--- /dev/null
+++ b/BACKEND
@@ -0,0 +1,40 @@
+$author: Ryan Rix <phrkonaleash@gmail.com>
+$cdate: 3Dec2009
+$mdate:
+
+Fedora-Tour
+
+This document describes the backend of fedora-tour in detail. Care should be
+taken to keep this document in sync with any development done on the project
+to aide future contributors and maintainers.
+
+1. File System Layout
+
+2. Content Descriptors
+
+The content displayed in Fedora-tour is organized by freedesktop.org .desktop files[1]. They should exist in tourContentDescriptors as described in Section 1. These files have a non-standard entries to define details about a particular module of content.
+
+ [Desktop Entry]
+ Type=x-content-Fedora-Tour
+ Version=F-13
+ Name=What is Fedora Linux?
+ // Localized Name entries follow
+ Comment=Fedora is a Linux based operating system that provides users with access to the latest free and open source software, in a stable, secure and easy to manage form.
+ // Localized Comment entries follow
+ Icon=fedora-logo-sprite
+ X-DocPath=what-is-fedora
+ Priority=2
+
+Type: Type should always be x-content-Fedora-Tour, to eliminate any possible confusion with other documentation tools' or applications' data.
+
+Version: Describes for which release of Fedora the content is valid.
+
+Name: This is the Name that will be displayed in the Tour's tree view
+
+Comment: This will be displayed as a tooltip when the user hovers over the entry in the tour Treeview or Sidemenu.
+
+Icon: This is the name of the icon that will displayed in the Treeview and Sidemenu.
+
+X-DocPath: This custom entry tells which folder in
+
+[1] http://standards.freedesktop.org/desktop-entry-spec/latest/ \ No newline at end of file