From 10b546f7f974ac8e157426ee42d7abdd52dbf14b Mon Sep 17 00:00:00 2001 From: Michael Drake Date: Mon, 19 Jan 2004 00:48:57 +0000 Subject: [project @ 2004-01-19 00:48:57 by tlsa] Move themes document and update user guide with keyboard and URL shortcuts. Plus minor tweaks. svn path=/import/netsurf/; revision=489 --- !NetSurf/Docs/en/dev,faf | 4 ++-- !NetSurf/Docs/en/index,faf | 19 ++++++++++++++--- !NetSurf/Docs/en/info,faf | 4 ++-- !NetSurf/Docs/en/intro,faf | 2 +- !NetSurf/Docs/en/themes,faf | 50 +++++++++++++++++++++++++++++++++++++++++++++ !NetSurf/Docs/en/user,faf | 26 +++++++++++++++++++++-- 6 files changed, 95 insertions(+), 10 deletions(-) create mode 100644 !NetSurf/Docs/en/themes,faf (limited to '!NetSurf/Docs') 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 @@ -

Developer Information

Contribution to the project

As NetSurf is an open source project, everyone is welcome to contribute. If you would like to add some functionality to NetSurf then you can contact the other developers via either the #netsurf-develop IRC channel or mailing list.

@@ -23,5 +23,5 @@

Further information

There is further developer information generated by Doxygen.

- + \ 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 @@ -

Introduction

NetSurf is an open-source web browser for RISC OS. Its aim is to bring the HTML 4 (HyperText Markup Language) and CSS (Cascading Style Sheet) technologies to the RISC OS platform. Currently, NetSurf supports only a fraction of these standards.

Documentation

@@ -29,6 +29,8 @@

@@ -40,6 +42,17 @@

Further information

+ +

NetSurf Themes

+ +

Contributors

@@ -56,7 +69,7 @@

Andrew Poole - (GUI stuff)

Andrew Duffell - (Website work, NetSurf logo and other graphics, beta testing)

James Shaw - (Started the NetSurf project)

Michael Drake - (This documentation, beta testing)

Michael Drake - (Most of this documentation, default theme graphics, beta testing)

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 mailing list or contact me directly.

License

@@ -65,6 +78,6 @@

NetSurf Links

Project homepage
Recent builds
Web CVS interface

- + \ 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 @@ -

User Information

Requirements

NetSurf requires the SharedUnixLibrary to run. Also, you may need to download the Acorn URI module.

@@ -53,6 +53,6 @@

PNGs with transparency don't display correctly unless you have Select.

NetSurf quits when it runs out of memory

- + \ 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 - + 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 @@ + + + +NetSurf: The open-source web browser for RISC OS + + + + +

NetSurf Themes

Introduction & Overview

NetSurf has inbuilt support for themed icons and status bar tools. This document details how to create your own themes for NetSurf.

Tools Required

In order to create a new theme, you will require the following tools:

A template editor
A sprite file editor

Creating Templates

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.

The templates file must contain one template. It should be called "toolbar".

Toolbar

The toolbar template must contain the following icons, which must be numbered (as indicated in parentheses):

Throbber (1)
URL entry bar (2)
Status bar (3)
History Button (4)
Refresh Button (5)
Stop Button (6)
Back Button (7)
Forward Button (8)
Bookmark Button (9)
Save Button (10)
Print Button (11)
Home Button (12)

Sprites

Sprites should be contained in a single file named "Sprites".

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).

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)

Optional Preview Sprite

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".

Packaging your Theme

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.

Submitting your Theme

Themes may be uploaded to the central NetSurf Theme repository at http://netsurf.sourceforge.net/themes/.

+ + \ 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 @@ -

User Guide

Using NetSurf

To run NetSurf, 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.

@@ -50,6 +50,28 @@

Navigate > Home This take you back to the NetSurf homepage.

Navigate > Back This has the same function as the back button on the toolbar.

Navigate > Forward This has the same function as the forward button on the toolbar.

Keyboard Shortcuts

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.

+ + + + + + + + + + + +

Shortcut	Function
Page Down	Scroll down by one page
Page Up	Scroll up by one page
Cursor Down	Scroll down one line
Cursor Up	Scroll up one line
Ctrl+Cursor Down	Go to bottom of page
Ctrl+Cursor Up	Go to top of page
F8	View webpage source
F9	Dumps the box tree into stderr if it's an html page Dumps the css into stderr if it's a CSS content
F10	Dumps the cache into stderr
Ctrl+F2	Closes the window

URL Shortcuts

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.

+ + + + + +

Shortcut	Page
about:	The NetSurf About page
about:cookies	List of cookies stored by NetSurf
help:	NetSurf documentation
home:	NetSurf home page

Configuring NetSurf

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.

Configuration Panel
Note: Screenshot taken on RISC OS Select 3

@@ -62,5 +84,5 @@

Theme

NetSurf allows you to change the 'look and feel' of its interface. New themes can be downloaded from the NetSurf themes page and you can select your desired theme from this window.

Theme Selection Window
Note: Screenshot taken on RISC OS Select 3

- + \ No newline at end of file -- cgit v1.2.3