mirrors/netsurf
1
0
Fork 0
mirror of https://github.com/netsurf-browser/netsurf synced 2024-11-23 14:59:47 +03:00
Code Issues Packages Projects Releases Wiki Activity

[project @ 2003-11-23 18:08:07 by jmb]

Browse Source 
Bring themes documentation in line with code.

svn path=/import/netsurf/; revision=422
This commit is contained in:
John Mark Bell 2003-11-23 18:08:07 +00:00
parent 0fbc1b4ba5
commit b8cd833cfd
1 changed files with 9 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
documentation/Themes.xml
View File

@ -2,7 +2,7 @@
<!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.3 2003/06/21 15:55:42 jmb Exp $ -->
<!-- $Id: Themes.xml,v 1.4 2003/11/23 18:08:07 jmb Exp $ -->
<riscos-prm doc-group="NetSurf User's Manual">
<chapter title="NetSurf Themes">
@ -16,7 +16,6 @@
<list type="unordered">
<item><p> A template editor </p></item>
<item><p> A sprite file editor </p></item>
<item><p> A text editor </p></item>
</list>
</p>
</section>
@ -24,23 +23,18 @@
<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 two templates. One is "toolbar", the other is "theme_info".</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:
<p>The toolbar template must contain the following icons, which <strong>must</strong> be numbered (as indicated in parentheses):
<list type="unordered">
<item><p> Back Button </p></item>
<item><p> Refresh Button </p></item>
<item><p> Forwards Button </p></item>
<item><p> Throbber </p></item>
<item><p> URL entry bar </p></item>
<item><p> Status bar </p></item>
<item><p> Throbber (1)</p></item>
<item><p> URL entry bar (2)</p></item>
<item><p> Status bar (3)</p></item>
<item><p> Back Button (4)</p></item>
<item><p> Refresh Button (5)</p></item>
</list></p>
</subsection>
<subsection title="Theme Info">
<p>The theme_info template details the theme in a graphical manner. It is similar to a program info dialogue box and should be treated as such. Again, the Default theme is a good source of reference.</p>
</subsection>
</section>
<section title="Sprites">
@ -54,18 +48,6 @@
<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="Text Files">
<p>There are two text files which also make up the theme.</p>
<subsection title="Icon Names">
<p>The IconNames text file provides the link between the template and the program. Each icon has a name defined internally by NetSurf (eg TOOLBAR_BACK). It is necessary to map these internal names to the icon numbers in the template. See the default theme for reference. All icons should be defined.</p>
</subsection>
<subsection title="Icon Sizes">
<p>The IconSizes text file is best left alone. Simply copy the one from the default theme into your theme.</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>
@ -85,6 +67,7 @@
<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."/>
</history>
</meta>
</riscos-prm>