source: appstream-generator/data/templates/debian/main.html @ 4841

Last change on this file since 4841 was 4841, checked in by Juanma, 2 years ago

Initial release

File size: 3.1 KB
Line 
1{{#partial}}{title}Start{{/partial}}
2
3{{#partial}}{ header_content }
4<span>AppStream data hints for {{project_name}}</span>
5{{/partial}}
6
7{{#partial}}{ content }
8<div class="wrapper">
9
10    <h1>Welcome!</h1>
11    <p>Welcome to the AppStream Generator HTML pages!</p>
12    <p>
13      These pages exist to provide a user-friendly view on the issues discovered by the
14      AppStream metadata generator while extracting metadata from packages in the {{project_name}} archive.
15      They can also be used to take a look at the raw metadata, to spot possible problems
16      with the data itself or the generation process.
17    </p>
18
19    <h1>Select a suite</h1>
20    {{#oldsuites}}
21      <h3><a href="{{suite}}/index.html">{{suite}}</a></h3>
22    {{/oldsuites}}
23    {{#suites}}
24      <h3><a href="{{suite}}/index.html">{{suite}}</a></h3>
25    {{/suites}}
26
27    <br/><hr/>
28    <img src="{{root_url}}/static/img/asgen.png" alt="AppStream Generator Logo" style="margin: 4px; float: right;" />
29
30    <h1>What is AppStream and DEP-11?</h1>
31    <p>
32      AppStream is a cross-distro XML format to provide metadata for software components and to assign unique identifiers to software.<br/>
33      In Debian, we parse all XML provided by upstream projects as well as other metadata (.desktop-files, ...), and compile a single YAML
34      metadata file from it, which is then shipped to users via APT.
35    </p>
36    <p>
37      While the official AppStream specification is based on XML, Debian uses a YAML version of the format for easier use in existing
38      scripts and for better archive integration. This format is called DEP-11, and initially had a much wider scope in enhancing
39      archive metadata than AppStream had. Today AppStream covers that as well, and DEP-11 is only a YAML version of AppStream.
40    </p>
41    <p>
42      The generated metadata can for example be used by software centers like GNOME Software or KDE Discover to display a user-friendly application-centric
43      view on the package archive.<br/>
44      It can also be used by other software to find missing plugins, codecs, fonts, etc. or simply by users to install software on any Linux distribution
45      without knowing the exact package name.
46    </p>
47
48    <h1>More information</h1>
49    <p>
50      See <a href="https://wiki.debian.org/AppStream">AppStream @ wiki.d.o</a> for information about AppStream integration and usage in Debian.<br/>
51      The offical AppStream specification can be found at <a href="http://www.freedesktop.org/software/appstream/docs/">freedesktop.org</a>, a description
52      of the <a href="http://www.freedesktop.org/software/appstream/docs/sect-AppStream-DEP11.html">DEP-11 YAML format</a> is hosted there as well.
53    </p>
54    <p>
55      You can find the source-code of the AppStream Generator <a href="https://github.com/ximion/appstream-generator">here</a>.
56    </p>
57    <p>
58      Log files of the generator runs are stored in <a href="logs/">logs/</a>, machine-readable issue hints can be found in <a href="hints/">hints/</a>,
59      valid metadata is located in <a href="data/">data/</a> and all exported media is made available via <a href="media/">media/</a>.
60    </p>
61
62</div>
63{{/partial}}
64
65{{> base}}
Note: See TracBrowser for help on using the repository browser.