Updated documentation (PXML_schema.xsd and human readable version) and genpxml.sh...
[pandora-libraries.git] / testdata / scripts / genpxml.sh
index d54f683..f859bfa 100755 (executable)
@@ -15,15 +15,23 @@ echo '
 <PXML xmlns="http://openpandora.org/namespaces/PXML" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="PXML_schema.xsd">
 
   <application id="'$BASENAME-$rnd'">
+    <exec command="'$BASENAME'"/>
 
     <title lang="en_US">'$BASENAMEnoex'</title>
-    <title lang="de_DE">'$BASENAMEnoex' - German (lol!)</title>
+    <title lang="de_DE">'$BASENAMEnoex' - German (lol!)</title><!--optional, only one title tag required-->
  
-    <exec command="'$BASENAME'"/>
+    <author name="'$USERNAME'" website="http://www.openpandora.org"/><!--Optional email and website, name required-->
+    <version major="1" minor="1" release="1" build="2"/><!--This programs version-->
+    <osversion major="1" minor="0" release="0" build="0"/><!--The minimum OS version required, optional-->
  
     <description lang="en_US">en_US Automatically generated pxml from'$(pwd)' exe='$BASENAME'</description>
     <description lang="de_DE">de_DE Automatisch generiertes pxml aus'$(pwd)' exe='$BASENAME'</description>
  
+    <!-- if you want to provide an icon, uncomment the following line and set correct filename! -->
+    <!-- <icon src="icon.png"/> -->
     <previewpics>'
 #add all images in the folder as preview pics
 for image in $(file -i -0 * | grep -a image | cut -d" " -f1)
@@ -32,14 +40,17 @@ echo "      <pic src="$image"/>"
 done
 echo '    </previewpics>
  
-    <author name="'$USERNAME'" website="http://www.openpandora.org"/><!--Optional email and website, name required-->
-    <version major="1" minor="1" release="1" build="2"/><!--This programs version-->
-    <osversion major="1" minor="0" release="0" build="0"/><!--The minimum OS version required-->
+    <!-- if you want to provide a manual, uncomment the following line and set correct values! -->
+    <!-- <info name="'$BASENAMEnoex' manual" type="text/html" src="manual.html"/> -->
  
     <categories>
-      <category name="Main category"><!--category like "Games", "Graphics", "Internet" etc-->
-        <subcategory name="Subcategory 1"/><!--subcategory, like "Board Games", "Strategy", "First Person Shooters"-->
+    <!-- for information about valid categories and explainations of them, please have a look at this website:
+         http://standards.freedesktop.org/menu-spec/menu-spec-latest.html#category-registry
+         entries with invalid category/subcategory combinations will appear under "others" in the menus! -->
+      <category name="Main category">
+      <!--valid values for "Main category": "AudioVideo", "Audio", "Video", "Development", "Education", "Game", "Graphics", "Network", "Office", "Settings", "System", "Utility"-->
+        <subcategory name="Main Subcategory"/>
+        <!--valid Values for "Subcategory": "Building", "Debugger", "IDE", "GUIDesigner", "Profiling", "RevisionControl", "Translation", "Calendar", "ContactManagement", "Database", "Dictionary", "Chart", "Email", "Finance", "FlowChart", "PDA", "ProjectManagement", "Presentation", "Spreadsheet", "WordProcessor", "2DGraphics", "VectorGraphics", "RasterGraphics", "3DGraphics", "Scanning", "OCR", "Photography", "Publishing", "Viewer", "TextTools", "DesktopSettings", "HardwareSettings", "Printing", "PackageManager", "Dialup", "InstantMessaging", "Chat", "IRCClient", "FileTransfer", "HamRadio", "News", "P2P", "RemoteAccess", "Telephony", "TelephonyTools", "VideoConference", "WebBrowser", "WebDevelopment", "Midi", "Mixer", "Sequencer", "Tuner", "TV", "AudioVideoEditing", "Player", "Recorder", "DiscBurning", "ActionGame", "AdventureGame", "ArcadeGame", "BoardGame", "BlocksGame", "CardGame", "KidsGame", "LogicGame", "RolePlaying", "Simulation", "SportsGame", "StrategyGame", "Art", "Construction", "Music", "Languages", "Science", "ArtificialIntelligence", "Astronomy", "Biology", "Chemistry", "ComputerScience", "DataVisualization", "Economy", "Electricity", "Geography", "Geology", "Geoscience", "History", "ImageProcessing", "Literature", "Math", "NumericalAnalysis", "MedicalSoftware", "Physics", "Robotics", "Sports", "ParallelComputing", "Amusement", "Archiving", "Compression", "Electronics", "Emulator", "Engineering", "FileTools", "FileManager", "TerminalEmulator", "Filesystem", "Monitor", "Security", "Accessibility", "Calculator", "Clock", "TextEditor", "Documentation", "Core", "KDE", "GNOME", "GTK", "Qt", "Motif", "Java", "ConsoleOnly"-->
         <subcategory name="Subcategory 2"/>
       </category>
       <category name="Alternative category">
@@ -47,9 +58,10 @@ echo '    </previewpics>
       </category>
     </categories>
  
-    <clockspeed frequency="600"/><!--Frequency in Hz-->
+    <!-- if you want to set a fixed clockrate differening from the default (500MHz), uncomment the following line and set it to the value you want (in MHz) -->
+    <!-- <clockspeed frequency="600"/> -->
 
   </application>
 
 </PXML>
-'
\ No newline at end of file
+'