~gdesklets-desklet-team/gdesklets/0.36

« back to all changes in this revision

Viewing changes to doc/book/meta.xml

  • Committer: Robert Pastierovic
  • Date: 2007-10-07 10:08:42 UTC
  • Revision ID: pastierovic@gmail.com-20071007100842-fdvp2vzmqgh1j87k
merged 0.3x branch and basic documentation and some other changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<chapter id="meta" xmlns:xi="http://www.w3.org/2001/XInclude">
 
2
  <title>Meta-Data</title>
 
3
 
 
4
<section id="meta-tag"><title>&lt;meta&gt;</title>
 
5
 
 
6
  <para>The <literal>meta</literal> tag contains information about your
 
7
    desklet shown in the shell.</para>
 
8
 
 
9
  <section><title>Attributes</title>
 
10
 
 
11
    <informaltable frame="topbot">
 
12
    <tgroup>
 
13
 
 
14
    <thead>
 
15
      <row>
 
16
        <entry>Name</entry>
 
17
        <entry>Description</entry>
 
18
      </row>
 
19
    </thead>
 
20
 
 
21
    <tbody>
 
22
      <row>
 
23
        <entry valign="top">author</entry>
 
24
        <entry valign="top">The name of the person(s) who wrote the
 
25
          desklet.</entry>
 
26
      </row>
 
27
      <row>
 
28
        <entry valign="top">category</entry>
 
29
        <entry valign="top">The category in which the desklet should
 
30
          be.</entry>
 
31
      </row>
 
32
      <row>
 
33
        <entry valign="top">dependency</entry>
 
34
        <entry valign="top">The minimum version of <application>gDesklets</application>
 
35
          on which the desklet is dependent.</entry>
 
36
      </row>
 
37
      <row>
 
38
        <entry valign="top">description</entry>
 
39
        <entry valign="top">A short description of the desklet.</entry>
 
40
      </row>
 
41
      <row>
 
42
        <entry valign="top">name</entry>
 
43
        <entry valign="top">The name of the desklet.</entry>
 
44
      </row>
 
45
      <row>
 
46
        <entry valign="top">preview</entry>
 
47
        <entry valign="top">Path to an image representing the display.  This
 
48
          could be an icon or an actual screenshot, for example.</entry>
 
49
      </row>
 
50
    </tbody>
 
51
 
 
52
    </tgroup>
 
53
    </informaltable>
 
54
 
 
55
  </section>
 
56
 
 
57
  <programlisting><![CDATA[
 
58
<display>
 
59
 
 
60
  <meta author="George D. Esklet"
 
61
        version="0.1"
 
62
        name="MyFirstDesklet"
 
63
        category="misc/utilities"
 
64
        description="A display to show off my Python-writing skills."
 
65
        dependency="0.33.1"
 
66
        preview="gfx/icon.png"/>
 
67
 
 
68
</display>
 
69
  ]]></programlisting>
 
70
</section>
 
71
 
 
72
</chapter>