summaryrefslogtreecommitdiff
path: root/!NetSurf
diff options
context:
space:
mode:
Diffstat (limited to '!NetSurf')
-rw-r--r--!NetSurf/Docs/en/dev,faf4
-rw-r--r--!NetSurf/Docs/en/index,faf19
-rw-r--r--!NetSurf/Docs/en/info,faf4
-rw-r--r--!NetSurf/Docs/en/intro,faf2
-rw-r--r--!NetSurf/Docs/en/themes,faf50
-rw-r--r--!NetSurf/Docs/en/user,faf26
6 files changed, 95 insertions, 10 deletions
diff --git a/!NetSurf/Docs/en/dev,faf b/!NetSurf/Docs/en/dev,faf
index e2a81524a..8e63d699b 100644
--- a/!NetSurf/Docs/en/dev,faf
+++ b/!NetSurf/Docs/en/dev,faf
@@ -7,7 +7,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
-<p class="logosmall"><a href="http://netsurf.sourceforge.net/"><img src="images/logosmall" alt="NetSurf"></a></p>
+<p class="logosmall"><a href="index"><img src="images/logosmall" alt="NetSurf"></a></p>
<h1>Developer Information</h1>
<h2><a name="contri">Contribution to the project</a></h2>
<p>As <em>NetSurf</em> is an open source project, everyone is welcome to contribute. If you would like to add some functionality to NetSurf then you can <a href="info#devel">contact the other developers</a> via either the #netsurf-develop IRC channel or mailing list.</p>
@@ -23,5 +23,5 @@
</ul>
<h2><a name="further">Further information</a></h2>
<p>There is further <a href="http://netsurf.strcprstskrzkrk.co.uk/codedocs/">developer information</a> generated by Doxygen.</p>
-<p class="footer">NetSurf is copyright 2003 The NetSurf Developers<br>This page was written by Michael Drake</p>
+<p class="footer">NetSurf is copyright 2003 - 2004 The NetSurf Developers<br>This page was written by Michael Drake</p>
</body></html> \ No newline at end of file
diff --git a/!NetSurf/Docs/en/index,faf b/!NetSurf/Docs/en/index,faf
index edcec6fed..24e33c203 100644
--- a/!NetSurf/Docs/en/index,faf
+++ b/!NetSurf/Docs/en/index,faf
@@ -7,7 +7,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
-<h1 class="logofull"><a href="http://netsurf.sourceforge.net/"><img src="images/logofull" alt="NetSurf"></a></h1>
+<h1 class="logofull"><a href="intro"><img src="images/logofull" alt="NetSurf"></a></h1>
<h2>Introduction</h2>
<p><em>NetSurf</em> is an open-source web browser for RISC&nbsp;OS. Its aim is to bring the HTML 4 (HyperText Markup Language) and CSS (Cascading Style Sheet) technologies to the RISC&nbsp;OS platform. Currently, NetSurf supports only a fraction of these standards.</p>
<h2>Documentation</h2>
@@ -29,6 +29,8 @@
<ul><li><a href="user#using">Using NetSurf</a></li>
<li><a href="user#toolbar">Toolbar description</a></li>
<li><a href="user#menus">Menus</a></li>
+<li><a href="user#keys">Keyboard shortcuts</a></li>
+<li><a href="user#urls">URL shortcuts</a></li>
<li><a href="user#conf">Configuration</a></li>
</ul></td>
</tr>
@@ -40,6 +42,17 @@
<li><a href="dev#further">Further information</a></li>
</ul></td>
</tr>
+<tr>
+<th class="contents"><p><a href="themes">NetSurf Themes</a></p></th>
+<td class="contents">
+<ul><li><a href="themes#intro">Introduction &amp; Overview</a></li>
+<li><a href="themes#tools">Tools required</a></li>
+<li><a href="themes#templates">Creating templates</a></li>
+<li><a href="themes#sprites">Sprites</a></li>
+<li><a href="themes#package">Packaging your theme</a></li>
+<li><a href="themes#submit">Submitting your theme</a></li>
+</ul></td>
+</tr>
</table>
</div>
<h2>Contributors</h2>
@@ -56,7 +69,7 @@
<li>Andrew Poole - <em>(GUI stuff)</em></li>
<li>Andrew Duffell - <em>(Website work, NetSurf logo and other graphics, beta testing)</em></li>
<li>James Shaw - <em>(Started the NetSurf project)</em></li>
-<li>Michael Drake - <em>(This documentation, beta testing)</em></li>
+<li>Michael Drake - <em>(Most of this documentation, default theme graphics, beta testing)</em></li>
</ul>
<p>Also, thanks to everyone else who has helped with bug reports and suggestions. If you feel you should be mentioned on the above list or have any other issues with it, please post to the <a href="info#devel">mailing list</a> or <a href="mailto:mike@smoothartist.com">contact me</a> directly.</p>
<h2>License</h2>
@@ -65,6 +78,6 @@
<h2>NetSurf Links</h2>
<p><a href="http://netsurf.sourceforge.net/">Project homepage</a><br><a href="http://netsurf.strcprstskrzkrk.co.uk/">Recent builds</a><br><a href="http://cvs.semichrome.net/netsurf/">Web CVS interface</a></p>
-<p class="footer">NetSurf is copyright 2003 The NetSurf Developers<br>This page was written by Michael Drake</p>
+<p class="footer">NetSurf is copyright 2003 - 2004 The NetSurf Developers<br>This page was written by Michael Drake</p>
</body></html> \ No newline at end of file
diff --git a/!NetSurf/Docs/en/info,faf b/!NetSurf/Docs/en/info,faf
index c9424745b..cbec4211a 100644
--- a/!NetSurf/Docs/en/info,faf
+++ b/!NetSurf/Docs/en/info,faf
@@ -7,7 +7,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
-<p class="logosmall"><a href="http://netsurf.sourceforge.net/"><img src="images/logosmall" alt="NetSurf"></a></p>
+<p class="logosmall"><a href="index"><img src="images/logosmall" alt="NetSurf"></a></p>
<h1>User Information</h1>
<h3><a name="requ">Requirements</a></h3>
<p>NetSurf requires the <a href="http://www.chocky.org/unix/usage.html">SharedUnixLibrary</a> to run. Also, you may need to download the <a href="http://sudden.recoil.org/others/">Acorn URI module</a>.</p>
@@ -53,6 +53,6 @@
<li>PNGs with transparency don't display correctly unless you have Select.</li>
<li>NetSurf quits when it runs out of memory</li>
</ul>
-<p class="footer"><em>NetSurf</em> is copyright 2003 The NetSurf Developers<br>This page was written by Michael Drake</p>
+<p class="footer"><em>NetSurf</em> is copyright 2003 - 2004 The NetSurf Developers<br>This page was written by Michael Drake</p>
</body>
</html> \ No newline at end of file
diff --git a/!NetSurf/Docs/en/intro,faf b/!NetSurf/Docs/en/intro,faf
index 976f56850..0cd086987 100644
--- a/!NetSurf/Docs/en/intro,faf
+++ b/!NetSurf/Docs/en/intro,faf
@@ -71,7 +71,7 @@ mailing list</a></dt>
</div>
-<p class="footer"><em>NetSurf</em> is copyright 2003 The NetSurf Developers</p>
+<p class="footer"><em>NetSurf</em> is copyright 2003 - 2004 The NetSurf Developers</p>
</body>
</html>
diff --git a/!NetSurf/Docs/en/themes,faf b/!NetSurf/Docs/en/themes,faf
new file mode 100644
index 000000000..65ac2ab6b
--- /dev/null
+++ b/!NetSurf/Docs/en/themes,faf
@@ -0,0 +1,50 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+ "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+<title>NetSurf: The open-source web browser for RISC OS</title>
+<link rel="stylesheet" type="text/css" href="netsurf">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</head>
+<body>
+<p class="logosmall"><a href="index"><img src="images/logosmall" alt="NetSurf"></a></p>
+<h1>NetSurf Themes</h1>
+<h2><a name="intro">Introduction &amp; Overview</a></h2>
+<p><em>NetSurf</em> has inbuilt support for themed icons and status bar tools. This document details how to create your own themes for NetSurf.</p>
+<h2><a name="tools">Tools Required</a></h2>
+<p>In order to create a new theme, you will require the following tools:</p>
+<ul>
+<li>A template editor</li>
+<li>A sprite file editor</li>
+</ul>
+<h2><a name="templates">Creating Templates</a></h2>
+<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 &quot;toolbar&quot;.</p>
+<h3>Toolbar</h3>
+<p>The toolbar template must contain the following icons, which <em>must</em> be numbered (as indicated in parentheses):</p>
+<ul>
+<li>Throbber (1)</li>
+<li>URL entry bar (2)</li>
+<li>Status bar (3)</li>
+<li>History Button (4)</li>
+<li>Refresh Button (5)</li>
+<li>Stop Button (6)</li>
+<li>Back Button (7)</li>
+<li>Forward Button (8)</li>
+<li>Bookmark Button (9)</li>
+<li>Save Button (10)</li>
+<li>Print Button (11)</li>
+<li>Home Button (12)</li>
+</ul>
+<h2><a name="sprites">Sprites</a></h2>
+<p>Sprites should be contained in a single file named &quot;Sprites&quot;.</p>
+<p>Throbber sprites should display the various stages of progress and should be named &quot;throbberN&quot;, 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>
+<h3>Optional Preview Sprite</h3>
+<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 &quot;preview&quot;.</p>
+<h2><a name="package">Packaging your Theme</a></h2>
+<p>The default packaging for NetSurf themes is simply a folder named the same as your theme name (eg &quot;Clear&quot; 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>
+<h2><a name="submit">Submitting your Theme</a></h2>
+<p>Themes may be uploaded to the central NetSurf Theme repository at <a href="http://netsurf.sourceforge.net/themes/">http://netsurf.sourceforge.net/themes/</a>.</p>
+<p class="footer">NetSurf is copyright 2003 - 2004 The NetSurf Developers<br>This page was written by John-Mark Bell</p>
+</body></html> \ No newline at end of file
diff --git a/!NetSurf/Docs/en/user,faf b/!NetSurf/Docs/en/user,faf
index 158825c3b..c8638f55a 100644
--- a/!NetSurf/Docs/en/user,faf
+++ b/!NetSurf/Docs/en/user,faf
@@ -7,7 +7,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</head>
<body>
-<p class="logosmall"><a href="http://netsurf.sourceforge.net/"><img src="images/logosmall" alt="NetSurf"></a></p>
+<p class="logosmall"><a href="index"><img src="images/logosmall" alt="NetSurf"></a></p>
<h1>User Guide</h1>
<h2><a name="using">Using NetSurf</a></h2>
<p>To run <em>NetSurf</em>, simply double click on the NetSurf application. This will cause the NetSurf icon to appear on the iconbar. Select clicking on this icon will open a browser window. It should be noted that as NetSurf is at a very early stage of development, much of the following information is subject to change without warning.</p>
@@ -50,6 +50,28 @@
<p><strong>Navigate > Home</strong> This take you back to the NetSurf homepage.</p>
<p><strong>Navigate > Back</strong> This has the same function as the back button on the <a href="#toolbar">toolbar</a>.</p>
<p><strong>Navigate > Forward</strong> This has the same function as the forward button on the <a href="#toolbar">toolbar</a>.</p>
+<h2><a name="keys">Keyboard Shortcuts</a></h2>
+<p>NetSurf supports keyboard shortcuts, which allow quick access to features and make NetSurf easier to use. The supported keypresses and corresponding functions are listed below.</p>
+<table border="0" cellpadding="2" cellspacing="0">
+<tr><th><p>Shortcut</p></th><th><p>Function</p></th></tr>
+<tr><td><p>Page Down</p></td><td><p>Scroll down by one page</p></td></tr>
+<tr><td><p>Page Up</p></td><td><p>Scroll up by one page</p></td></tr>
+<tr><td><p>Cursor Down</p></td><td><p>Scroll down one line</p></td></tr>
+<tr><td><p>Cursor Up</p></td><td><p>Scroll up one line</p></td></tr>
+<tr><td><p>Ctrl+Cursor Down</p></td><td><p>Go to bottom of page</p></td></tr>
+<tr><td><p>Ctrl+Cursor Up</p></td><td><p>Go to top of page</p></td></tr>
+<tr><td><p>F8</p></td><td><p>View webpage source</p></td></tr>
+<tr><td><p>F9</p></td><td><p>Dumps the box tree into stderr if it's an html page<br>Dumps the css into stderr if it's a CSS content</p></td></tr>
+<tr><td><p>F10</p></td><td><p>Dumps the cache into stderr</p></td></tr>
+<tr><td><p>Ctrl+F2</p></td><td><p>Closes the window</p></td></tr></table>
+<h2><a name="urls">URL Shortcuts</a></h2>
+<p>NetSurf also supports URL shortcuts, which allow quick access to various pages. The supported URL shortcuts are listed below. Type them into a NetSurf URL bar to see the corresponding page.</p>
+<table border="0" cellpadding="2" cellspacing="0">
+<tr><th><p>Shortcut</p></th><th><p>Page</p></th></tr>
+<tr><td><p>about:</p></td><td><p>The NetSurf About page</p></td></tr>
+<tr><td><p>about:cookies</p></td><td><p>List of cookies stored by NetSurf</p></td></tr>
+<tr><td><p>help:</p></td><td><p>NetSurf documentation</p></td></tr>
+<tr><td><p>home:</p></td><td><p>NetSurf home page</p></td></tr></table>
<h2><a name="conf">Configuring NetSurf</a></h2>
<p>You can change the way NetSurf looks and behaves, by configuring the program. The configuration panel is opened by clicking menu over the iconbar icon and selecting Choices.</p>
<p class="screenshot"><img src="images/conpan" alt="Configuration Panel" height="135" width="228"><br>Note: Screenshot taken on RISC OS Select 3</p>
@@ -62,5 +84,5 @@
<h3>Theme</h3>
<p>NetSurf allows you to change the 'look and feel' of its interface. New themes can be downloaded from the <a href="http://netsurf.sourceforge.net/themes/">NetSurf themes page</a> and you can select your desired theme from this window.</p>
<p class="screenshot"><img src="images/conthem" alt="Theme Selection Window" height="262" width="347"><br>Note: Screenshot taken on RISC OS Select 3</p>
-<p class="footer">NetSurf is copyright 2003 The NetSurf Developers<br>This page was written by Michael Drake</p>
+<p class="footer">NetSurf is copyright 2003 - 2004 The NetSurf Developers<br>This page was written by Michael Drake</p>
</body></html> \ No newline at end of file