From dfa6a03ade3c34bfeed3b99b31ddf9c45f08fc08 Mon Sep 17 00:00:00 2001 From: Ryan Rix Date: Fri, 4 Dec 2009 14:13:58 -0700 Subject: Not sure why these got reverted... --- docs/BACKEND | 111 +++++++++++++++++++++++++++++++++++++++++-------- docs/fedora-tour-1.png | Bin 157949 -> 149010 bytes docs/fedora-tour-1.svg | 89 ++++++++++++++++++++++----------------- docs/tour-mockup-1.odg | Bin 38988 -> 38537 bytes 4 files changed, 143 insertions(+), 57 deletions(-) diff --git a/docs/BACKEND b/docs/BACKEND index 587e90b..58f9106 100644 --- a/docs/BACKEND +++ b/docs/BACKEND @@ -10,31 +10,106 @@ to aide future contributors and maintainers. 1. File System Layout +/usr/bin/fedora-tour : This is the main executable for + : Fedora-tour. + +/usr/share/fedora-tour : + +/usr/share/fedora-tour/packages : tourContentDescriptorsDir. The location + : of Content Descriptors defining content + : for Fedora-tour + +/usr/share/fedora-tour/content-enUS/ : tourContentDirectoryLocalized. This is + : the location of the actual content, used +/usr/share/fedora-tour/content-enGB/ : in generating a full DocRoot for a +...etc... : particular Package in cooperation with + : the Locale entry of the Package. + 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. +Content Descriptors are the files in tourContentDescriptorsDir which describe +the content of a particular Fedora Tour package. These are XML descriptions of +each page and are used to generate the menues. When the application loads the +menu, it will search tourContentDescriptorsDir for a list of .xml files, parse +each one + +A rough outline of the typical Content Descriptor, with explanation follows. + + + + What is the Fedora Project? + fedora-logo-sprite + 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 + what-is-fedora + enUS + 1 + + Overview + This section provides a brief overview of the Fedora Project +Community and Fedora Linux. + overview.html + HTML + + + Our Mission and Goals + mission-and-goals.html + HTML + + Foundation 1: Freedom + mission-and-goals/freedom.html + HTML + + + Foundation 2: Friends + mission-and-goals/friends.html + HTML + + + Foundation 3: Features + mission-and-goals/features.html + HTML + + + Foundation 4: First + mission-and-goals/first.html + HTML + + + + +DisplayName: This is the name that will appear on either the TreeView or +MenuView. It should be short, as the length of the visible column will be +variable. + +Icon: The name of the icon to be displayed in TreeView and MenuView. Fedora-Tour +will poll standard application icon directories (/usr/share/pixmaps, +/usr/share/icons and /usr/share/icons/hicolor) for this icon. Only file's +basename is required, but if extension is provided, it will be used as first +priority, in the case of multiple icons. +* This entry is only valid as a direct child of Package. - [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 +Comment: This will be displayed as a tooltip when a user mouses over the leaf in +TreeView or the entry in MenuView. -Type: Type should always be x-content-Fedora-Tour, to eliminate any possible confusion with other documentation tools' or applications' data. +DocRoot: The folder underneath tourContentDirectoryLocalized in which the +content resides. +* This entry is only valid as a direct child of Package. -Version: Describes for which release of Fedora the content is valid. +Priority: This entry defines how Fedora-tour will sort the top menu levels, when +generating a list from many XML files. In the case of multiple packages sharing +the same priority, alphabetical order will be used. +* This entry is only valid as a direct child of Package. The order of child +pages is ascertained from the order of entities in the XML file. -Name: This is the Name that will be displayed in the Tour's tree view +Locale: The Locale of the package for i18n support. Used to generate the proper +DocRoot -Comment: This will be displayed as a tooltip when the user hovers over the entry in the tour Treeview or Sidemenu. +Page: This entry opens a new page. -Icon: This is the name of the icon that will displayed in the Treeview and Sidemenu. +File: Where in DocRoot this Page entry resides -X-DocPath: This custom entry tells which folder in +Type: The content type. What will be supported will be defined at some later +time than now. Currently, only HTML. TODO -[1] http://standards.freedesktop.org/desktop-entry-spec/latest/ \ No newline at end of file diff --git a/docs/fedora-tour-1.png b/docs/fedora-tour-1.png index 5c11fe6..ecd69aa 100644 Binary files a/docs/fedora-tour-1.png and b/docs/fedora-tour-1.png differ diff --git a/docs/fedora-tour-1.svg b/docs/fedora-tour-1.svg index 4841dcc..88191d9 100644 --- a/docs/fedora-tour-1.svg +++ b/docs/fedora-tour-1.svg @@ -4,46 +4,57 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/tour-mockup-1.odg b/docs/tour-mockup-1.odg index 993c74a..ff6929e 100644 Binary files a/docs/tour-mockup-1.odg and b/docs/tour-mockup-1.odg differ -- cgit