May 4, 2017, 3:39:47 PM (4 years ago)

updated README

1 edited


  • devtools/desktop_to_xml/README

    r4583 r4585  
    3636If the package has an old rules file it's convenient to update it to the new format.
    3737If the operation fails it's better to remove the dir and "re-co" from svn to avoid unexpected behaviors of the script (that should no pass but just in case...)
     39The generated appfile.xml isn't a full one. It misses some important fields like the screenshots and the keywords. Keywords are needed to improve the search mechanism. For example, if gimp has "fotos" as a keyword when an user searches "programa para retocar fotos" the gimp will be one of the results.
     41Also we've implemented some features like the videos or the zmd and sh installers. Those aren't part of the appstream standard so we made some tricks to add them to the store.
     44                1) Defined as screenshots with "video" as image type. They could be from youtube or Vimeo (possibly also other sources, not tested) and we only need to put the url as the image.
     45                <screenshot>
     46                            <image type="video">https://www.youtube.com/watch?v=nu46uDbTZvc</image>
     47                </screenshot>
     49                2) Defined with the custom metadata tag  "x-video"
     50                        <metadata>
     51                      <value key="x-video">https://player.vimeo.com/video/65583694</value>
     52                        </metadata>
     54        Theorically the 2nd option is most "appstream-friendly" but as the api is in development it could be deprecated at any moment...
     57        In both cases the package must have the category "Zomando"
     59        1) Defined with the custom metadata tag "x-zomando"
     60                 <metadata>
     61                <value key="x-zomando">/usr/share/zero-center/zmds/zero-lliurex-adobeair-scratch2.zmd</value>
     62             </metadata>
     64        2) Defined using the pkgname field (without zmd extension)
     65                <pkgname>zero-lliurex-wine64</pkgname>
     67        2nd option is better as is 100% valid so we get ride of the custom tags and their uncertain future
     70        The package must have the category "Installer"
     72        The only supported way is to use an url tag of type "installer".
     73                <url type="installer"> http://download.netbeans.org/netbeans/8.2/final/bundles/netbeans-8.2-javaee-linux.sh/</url>
     75Zomandos and installers are already cataloged as appstream-generator (the tool that generates the catalog) can't parse them (logically) so when the catalogue is generated the "zomandos and installers catalogue" is added to the main software catalogue.
Note: See TracChangeset for help on using the changeset viewer.