summaryrefslogtreecommitdiff
path: root/documentation/Themes.xml
blob: 0aef2a97353aaa1d4c4918f1f799b3c036f6e554 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<?xml version="1.0"?>
<!DOCTYPE riscos-prm PUBLIC "-//Gerph//DTD PRM documentation 1.00//EN"
			    "http://www.movspclr.co.uk/dtd/100/prm.dtd">

<!-- $Id: Themes.xml,v 1.5 2004/01/05 20:20:44 tlsa Exp $ -->
			    
<riscos-prm doc-group="NetSurf User's Manual">
<chapter title="NetSurf Themes">
 <section title="Introduction and Overview">
  <p>NetSurf has inbuilt support for themed icons and status bar tools.<br/>
  This document details how to create your own themes for NetSurf</p>
 </section>

 <section title="Tools Required">
  <p>In order to create a new theme, you will require the following tools:
  <list type="unordered">
   <item><p> A template editor </p></item>
   <item><p> A sprite file editor </p></item>
  </list>
  </p> 
 </section>
 
 <section title="Creating Templates">
  <p>The best way to go about creating a new theme is to take the templates for the default theme and edit them with a template editor.</p>
  
  <p>The templates file must contain one template. It should be called "toolbar".</p>
  
  <subsection title="Toolbar">
   <p>The toolbar template must contain the following icons, which <strong>must</strong> be numbered (as indicated in parentheses):
   <list type="unordered">
    <item><p> Throbber (1)</p></item>
    <item><p> URL entry bar (2)</p></item>
    <item><p> Status bar (3)</p></item>
    <item><p> History Button (4)</p></item>   
    <item><p> Refresh Button (5)</p></item>
    <item><p> Stop Button (6)</p></item>
    <item><p> Back Button (7)</p></item>
    <item><p> Forward Button (8)</p></item>
    <item><p> Bookmark Button (9)</p></item>
    <item><p> Save Button (10)</p></item>
    <item><p> Print Button (11)</p></item>
    <item><p> Home Button (12)</p></item>
   </list></p>
  </subsection>
 </section>
 
 <section title="Sprites">
  <p>Sprites should be contained in a single file named "Sprites".</p>
  
  <p>Throbber sprites should display the various stages of progress and should be named "throbberN", where N is a numerical suffix (eg throbber0, throbber 23 etc).</p>
  
  <p>Button sprites can be called whatever you like. The only limitation is that two sprites are provided per button - one unpressed, the other pressed. Also, the template validation strings for each button should contain the sprite names (eg Sbackl,backp)</p>
  
  <subsection title="Optional Preview Sprite">
   <p>You may optionally provide a preview sprite for display in the theme configuration dialogue box. The sprite must be in a file called "Preview" and the sprite itself must be called "preview".</p>
  </subsection>
 </section>
 
 <section title="Packaging your Theme">
  <p>The default packaging for NetSurf themes is simply a folder named the same as your theme name (eg "Clear" for the Clear theme). Simply place all the files for your theme into a single directory, name the directory appropriately and create a Zip archive containing your theme.</p>
 </section>
 
 <section title="Submitting your Theme">
  <p>Themes may be uploaded to the central NetSurf theme repository at <reference type="link" href="http://netsurf.sourceforge.net/themes/">http://netsurf.sourceforge.net/themes/</reference></p>
 </section>
 
</chapter>

<meta>
 <maintainer>
  <email name="NetSurf Development Team" address="netsurf-develop@lists.sourceforge.net" />
 </maintainer>
 
 <history>
  <revision number="0.01" date="03/06/03" author="JMB" title="Initial version" />
  <revision number="0.02" date="03/06/03" author="JMB" title="Various changes for clarity" />
  <revision number="0.03" date="23/11/03" author="JMB" title="Updated after theme code tidy."/>
  <revision number="0.04" date="05/01/04" author="tlsa" title="Add new icons."/>
 </history>
</meta>
</riscos-prm>