--- /dev/null
+<?xml version="1.0" encoding="UTF-8"?>
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <title>The PXML file format</title>
+ <style type="text/css">
+ body { background-color: white; }
+ h1 {
+ color: rgb(0, 0, 32);
+ font: normal 2em sans-serif;
+ counter-reset: section;
+ border-bottom: thin solid blue;
+ }
+ h2:before {
+ counter-increment: section;
+ content: counter(section) ". ";
+ font: normal 0.5em sans-serif;
+ color: gray;
+ }
+ h2 {
+ margin-top: 2.1em;
+ color: rgb(0, 0, 64);
+ font: normal 1.4em sans-serif;
+ counter-reset: subsection;
+ }
+ h3:before {
+ counter-increment: subsection;
+ content: counter(section) ". " counter(subsection) ". ";
+ font: normal 0.5em sans-serif;
+ color: gray;
+ }
+ h3 {
+ margin-top: 2em;
+ color: rgb(0, 0, 96);
+ font: normal 1.2em sans-serif;
+ counter-reset: element;
+ }
+ h4:before {
+ counter-increment: element;
+ content: counter(section) ". " counter(subsection) ". " counter(element) ". ";
+ font: normal 0.5em sans-serif;
+ color: gray;
+ }
+ h4 {
+ margin-top: 0.5em;
+ color: rgb(0, 0, 128);
+ font: normal 1.1em sans-serif;
+ }
+ p {
+ color: rgb(64, 64, 64);
+ font: normal 1em sans-serif;
+ }
+ ol {
+ color: rgb(32, 32, 32);
+ font: normal 1em sans-serif;
+ }
+ div.code {
+ font: normal 1em monospace;
+ color: black;
+ background-color: rgb(196, 196, 196);
+ border: thin solid #888;
+ min-width: 10em;
+ margin: 1em;
+ padding: 0.5em;
+ overflow: auto;
+ outline: #444 solid thin;
+ }
+ brack:before { content: "("; } /* just for fun XD */
+ brack:after { content: ")"; }
+ imp { font-weight: bold; }
+ </style>
+ </head>
+ <body>
+ <h1>The PXML file format specification</h1>
+
+
+ <h2>Introduction</h2>
+ <p><imp>
+ Attention: at the present time, the PXML file format isn't set in stone, and is therefore subject to change.
+ There is no guarantee that the format or the schema are bug-free or will be changed at any time.
+ Please wait until this standard is finished before writing a PXML file.
+ </imp></p>
+ <p>
+ This is the human-readable specification for the PXML file format.
+ The PXML file format is used in <imp>your</imp> applications for the <a href="http://openpandora.org">OpenPandora®</a> <brack>that you package in <q>.pnd</q>-files or distribute otherwise</brack>, to make it possible for menus and launchers to use your applications and their properties.
+ </p>
+ <p>
+ A PXML file should be appended to your <q>.pnd</q>-file, using the tools provided for that purpose, or put in a directory that you want to serve as a redistributable package, to make it possible for launchers and menus to find it.
+ It should have the name <q>PXML.xml</q> <brack>not case sensitive</brack>, and there should only be one such file.
+ The contents of the PXML file should also comply to this specification <imp>without exception</imp>, to guarantee that everyone will be able to read it.
+ </p>
+ <p>
+ The PXML format is XML-based and fully XML-compliant, which means that it can be read and written by any XML reader or writer.
+ Included with this specification should also be a <q>.xsd</q>-file, which is used by XML tools to validate PXML files.
+ A <q>.xsd</q>-file is also known as a XML schema, and can be called the <q>computer-readable</q> version of this document. It is very good practice to validate your PXML-files with that schema before publishing them.
+ </p>
+ <p>
+ To write a PXML file, you also need to know the basics of writing a XML file.
+ It boils down to the following:
+ <ol>
+ <li>If an element contains text or other elements, it needs a start-tag and an end-tag. This looks like this:
+ <div class="code">
+ <exampleelement someattribute="something">something inside it</exampleeelement>
+ </div>
+ </li>
+ <li>If an element does <imp>not</imp> contain other elements or text, but only attributes, it looks like this:
+ <div class="code">
+ <exampleelement2 someattribute="something" />
+ </div>
+ </li>
+ </ol>
+ </p>
+
+
+ <h2>Format</h2>
+ <p>
+ The PXML-file is split up into multiple so-called <imp>elements</imp>, each of which specify one property of the
+ <q>.pnd</q>-package.
+ All of these elements are surrounded with a <imp><q><PXML></q>-tag</imp>, which tells the readers of the file that the data within that tag belongs to a PXML file. The tag and elements should be defined as follows:
+ </p>
+
+ <h3>The PXML-tag</h3>
+ <p>
+ The PXML-tag serves as the container for all PXML elements. It is the first thing that should occur in your PXML file.
+ An example <q><PXML></q>-tag would look like this:
+ </p>
+ <div class="code">
+ <PXML xmlns="http://openpandora.org/namespaces/PXML" id="uniqueID"><br/>
+ <!--All of the PXML elements should be put here--><br/>
+ </PXML>
+ </div>
+ <p>
+ As you can see, the PXML tag accepts a few <imp>attributes</imp>, namely the <q>id</q> and <q>xmlns</q> attributes.
+ </p>
+ <p>
+ The <imp><q>xmlns</q></imp> attribute is required by the XML standard, and guarantees that this file will be identified as a PXML file.
+ You <imp>must</imp> include the xmlns attribute, exactly as shown, in your PXML file, with the URL as specified.
+ Only then can it be guaranteed that the file will be read at all by launchers and menu apps.
+ </p>
+ <p>
+ The <imp><q>id</q></imp> attribute specifies an identifier for your PND package, and should be something globally unique so that no two PND packages have the same id.
+ This can be achieved by appending some random number to your application name, and to use that as your id; or to simply generate a completely random, very long id.
+ If this id already is used in another PND file, those two PND files will conflict with each other, and unforseeable errors will occur.
+ Please put effort into generating an unique id for your PXML-file.
+ </p>
+
+ <h3>The title element</h3>
+ <h4>Description</h4>
+ <p>
+ The <imp>title</imp> element specifies the text that is shown to the users of your PND file as the application title.
+ This element can be specified multiple times in multiple languages <brack>the language is indicated by the lang attribute</brack>.
+ </p>
+ <p>
+ At least one <q>title</q>-element is required, in the <q>en_US</q> <brack>American English</brack> language.
+ </p>
+ <h4>Example</h4>
+ <div class="code">
+ <title lang="en_US">Your application name</title><br/><br/>
+ <title lang="de_DE">Deinen Programmnamen</title>
+ </div>
+
+ <h3>The description element</h3>
+ <h4>Description</h4>
+ <p>
+ The <imp>description</imp> element specifies the text that is shown to the users of your PND file as the application description.
+ This element can be specified multiple times in multiple languages <brack>the language is indicated by the lang attribute</brack>.
+ </p>
+ <p>
+ At least one <q>description</q>-element is required, in the <q>en_US</q> <brack>American English</brack> language.
+ </p>
+ <h4>Example</h4>
+ <div class="code">
+ <description lang="en_US">Your long description of this application, describing it's purpose and highlighting it's features.</description><br/><br/>
+ <description lang="de_DE">Deine etwas längere Programmbeschreibung, die den Sinn des Programmes und den wichtigsten Features beschreiben sollte.</description>
+ </div>
+
+ <h3>The exec element</h3>
+ <h4>Description</h4>
+ <p>
+ The <imp>exec</imp> element should specify all the information needed to execute your application.<br/>
+ An exec element <imp>must</imp> be included in every PXML file.
+ It accepts the following attributes:
+ </p>
+ <p>
+ The <imp>command</imp> attribute specifies the path to the executable file.
+ This should be a relative path to a file within the PND package.
+ </p>
+ <p>
+ The <imp>startdir</imp> attribute specifies the starting directory <brack>Also known as the working directory</brack> that the application should start in.
+ This should be a relative path to a directory within the PND package, or to a well-known directory in the Pandora file system.
+ </p>
+ <p>
+ The <imp>standalone</imp> attribute specifies wether or not this application can run on its own, or if it needs parameters to run.<br/>
+ A value of <q>true</q> or <q>1</q> means that the application can be run without parameters.<br/>
+ A value of <q>false</q> or <q>0</q> means that the application must be run with parameters.
+ </p>
+ <p>
+ The <imp>background</imp> attribute specifies wether or not this application should run in the background, and it should be possible to switch to other apps while it is running, or if it is the only application that should be running.<br/>
+ A value of <q>true</q> or <q>1</q> means that the application can run in the background.<br/>
+ A value of <q>false</q> or <q>0</q> means that the application must be run as the only application.
+ </p>
+ <h4>Example</h4>
+ <div class="code">
+ <exec background="true" startdir="/usr/share/icons/" standalone="true" command="./myprogram"/>
+ </div>
+
+ <h3>The icon element</h3>
+ <h4>Description</h4>
+ <p>
+ The <imp>icon</imp> element should specify a nice icon for your program.<br/>
+ An icon element <imp>is optional</imp>.
+ It accepts the following attributes:
+ </p>
+ <p>
+ The <imp>src</imp> attribute specifies the path to the image file used as the icon.
+ </p>
+ <h4>Example</h4>
+ <div class="code">
+ <icon src="./images/icon.png"/>
+ </div>
+
+ <h3>The previewpics element</h3>
+ <h4>Description</h4>
+ <p>
+ The <imp>previewpics</imp> element is an element that contains multiple other elements.<br/>
+ A previewpics element <imp>is optional</imp>.
+ </p>
+ <p>
+ It contains multiple <imp>pic</imp>-elements. Every pic-element represents one preview picture.
+ If the previewpics element is specified, it must contain at least one pic element.
+ </p>
+ <p>
+ The <imp>src</imp> attribute on a pic element specifies the path to the image file used as the preview picture.
+ </p>
+ <h4>Example</h4>
+ <div class="code">
+ <previewpics><br/>
+ <pic src="./preview/pic1.jpg"/><br/>
+ <pic src="./preview/pic2.jpg"/><br/>
+ </previewpics>
+ </div>
+
+ <h3>The author element</h3>
+ <h4>Description</h4>
+ <p>
+ The <imp>author</imp> element is an element that is used by the author to introduce him/herself.<br/>
+ An author element <imp>is optional</imp>. It accepts the following attributes:
+ </p>
+ <p>
+ The <imp>name</imp> attribute specifies the name of the author.
+ </p>
+ <p>
+ The <imp>website</imp> attribute specifies the website of the author.
+ </p>
+ <p>
+ The <imp>email</imp> attribute specifies the e-mail of the author.<br/>
+ <imp>This attribute is not yet supported.</imp>
+ </p>
+ <h4>Example</h4>
+ <div class="code">
+ <author name="Bjornhild Andersson" website="http://some.website.with.author.info"/>
+ </div>
+
+ <h3>The version element</h3>
+ <h4>Description</h4>
+ <p>
+ The <imp>version</imp> element specifies the application version.<br/>
+ A version element <imp>is required</imp>. It accepts the following attributes:
+ </p>
+ <p>
+ The <imp>major</imp> attribute specifies the major version number. This number should be 0 or more.
+ </p>
+ <p>
+ The <imp>minor</imp> attribute specifies the minor version number. This number should be 0 or more.
+ </p>
+ <p>
+ The <imp>release</imp> attribute specifies the release number. This number should be 0 or more.
+ </p>
+ <p>
+ The <imp>build</imp> attribute specifies what build the application is at. This number should be 0 or more.
+ </p>
+ <h4>Example</h4>
+ <div class="code">
+ <version major="1" minor="1" release="1" build="2"/>
+ </div>
+
+ <h3>The osversion element</h3>
+ <h4>Description</h4>
+ <p>
+ The <imp>osversion</imp> element specifies the application version.<br/>
+ An osversion element <imp>is optional</imp>. It accepts the same attributes as the version element.
+ <h4>Example</h4>
+ <div class="code">
+ <osversion major="1" minor="1" release="1" build="2"/>
+ </div>
+
+ <h3>The categories element</h3>
+ <h4>Description</h4>
+ <p>
+ The <imp>categories</imp> element is an element that contains multiple other elements.<br/>
+ A categories element <imp>is required, and must contain at least one category</imp>.
+ </p>
+ <p>
+ It contains multiple <imp>category</imp>-elements. Every category-element represents one category that this app can be sorted into.
+ Valid categories are (among others):
+ <ol>
+ <li>Development</li>
+ <li>Education</li>
+ <li>Games</li>
+ <li>Graphics</li>
+ <li>Internet</li>
+ <li>Multimedia</li>
+ <li>Office</li>
+ <li>Settings</li>
+ <li>System</li>
+ <li>Utilities</li>
+ </ol>
+ </p>
+ <p>
+ The category-element takes one attribute: The <imp>name</imp>-attribute.
+ This attribute represents the category name, which preferrably should be one of the above.
+ </p>
+ <p>
+ A category-element can contain further child-elements: <imp>subcategory</imp>-elements.
+ These represent the subcategories of a category that the app will be sorted into.
+ </p>
+ <p>
+ The subcategory-element also takes a <imp>name</imp>-attribute; this attibute can contain any name for your subcategory.
+ </p>
+ <h4>Example</h4>
+ <div class="code">
+ <categories><br/>
+ <category name="Games"><br/>
+ <subcategory name="Strategy"/><br/>
+ <subcategory name="Turn-based"/><br/>
+ </category><br/>
+ <category name="Graphics"><br/>
+ <subcategory name="Image Editors"/><br/>
+ </category><br/>
+ </categories><br/>
+ </div>
+
+ <h3>The associations element</h3>
+ <h4>Description</h4>
+ <p>
+ The <imp>associations</imp> element is an element that contains multiple other elements.<br/>
+ An associations element <imp>is optional, except if exec.standalone is false</imp>.
+ </p>
+ <p>
+ It contains multiple <imp>association</imp>-elements. Every association-element represents one file action association.
+ </p>
+ <p>
+ The <imp>name</imp> attribute on an association element specifies the user-friendly action name for the association.
+ </p>
+ <p>
+ The <imp>filetype</imp> attribute on an association element specifies what file types (in MIME format) that this association should apply to.
+ </p>
+ <p>
+ The <imp>exec</imp> attribute on an association element specifies the command-line arguments that should be given to the program, when this action is performed.
+ The exec can contain a <q>%s</q>, which indicates where the file name of the file, that the action is performed on, should be inserted.<br/>
+ For example, if the exec-line is <q>--file %s --type lol</q>, and you have a file "lol.bmp" that the action is performed on, the exec-line is transformed into <q>--file "lol.bmp" --type lol</q>
+ </p>
+ <h4>Example</h4>
+ <div class="code">
+ <associations><br/>
+ <association name="Open Bitmap Image" filetype="image/bmp" exec="-f %s --no-deinterlacing"/><br/>
+ <association name="Crash the computer with a stylesheet" filetype="text/css" exec="-f %s --crash-on-success"/><br/>
+ </associations>
+ </div>
+
+ <h3>The clockspeed element</h3>
+ <h4>Description</h4>
+ <p>
+ The <imp>clockspeed</imp> element specifies what clockspeed this app should run at.<br/>
+ A clockspeed element <imp>is optional</imp>. It accepts the following attributes:
+ </p>
+ <p>
+ The <imp>frequency</imp> attribute specifies the wanted frequency, in megahertz <brack>mHz</brack>.
+ </p>
+ <h4>Example</h4>
+ <div class="code">
+ <clockspeed frequency="600"/>
+ </div>
+
+
+ <h2>Example file</h2>
+ <div class="code">
+ <?xml version="1.0" encoding="UTF-8"?><br/>
+ <PXML id="youruniqueID" xmlns="http://openpandora.org/namespaces/PXML"><br/>
+ <title lang="en_US">Program Title</title><br/>
+ <title lang="de_DE">German Program Title</title><br/>
+ <br/>
+ <exec background="true" startdir="/usr/share/icons/" standalone="true" command="./program"/><br/>
+ <br/>
+ <icon src="./program.png"/><br/>
+ <br/>
+ <description lang="en_US">This is the English Description of the file.</description><br/>
+ <description lang="de_DE">This would be the German description.</description><br/>
+ <br/>
+ <previewpics><br/>
+ <pic src="./preview/pic1.jpg"/><br/>
+ <pic src="./preview/pic2.jpg"/><br/>
+ </previewpics><br/>
+ <br/>
+ <author name="Some Dudeson" website="http://a.bc.de"/><br/>
+ <br/>
+ <version major="1" minor="1" release="1" build="2"/><br/>
+ <osversion major="1" minor="0" release="0" build="0"/><br/>
+ <br/>
+ <categories><br/>
+ <category name="Main category"><br/>
+ <subcategory name="Subcategory 1"/><br/>
+ <subcategory name="Subcategory 2"/><br/>
+ </category><br/>
+ <category name="Alternative category"><br/>
+ <subcategory name="Alternative Subcategory 1"/><br/>
+ </category><br/>
+ </categories><br/>
+ <br/>
+ <associations><br/>
+ <association name="View Word File" filetype="application/msword" exec="-f %s -t doc"/><br/>
+ </associations><br/>
+ <br/>
+ <clockspeed frequency="600"/><!--Frequency in Hz--><br/>
+ </PXML><br/>
+ </div>
+
+
+ <h2>Validation</h2>
+ <p>To validate a PXML file, you need a XSD (XML schema) validator, and you have to know how to use it.</p>
+ <p>You will also need to put the XML schema for the PXML format in the same folder as your PXML file.</p>
+ <p>
+ When you have done that, and know how to use it, you need to change a few things in your PXML file.
+ In your PXML tag, change the contents from this:
+ </p>
+ <div class="code">
+ <PXML id="..." xmlns="http://openpandora.org/namespaces/PXML">...
+ </div>
+ <p>...to this:</p>
+ <div class="code">
+ <PXML id="..." xmlns="http://openpandora.org/namespaces/PXML" <imp>xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="PXML_schema.xsd"</imp>>...
+ </div>
+ <p>
+ Now the PXML file can be validated.
+ </p>
+ </body>
+</html>
\ No newline at end of file
git.openpandora.org / pandora-libraries.git / blobdiff