From 5f5fa631013417dd4c9010e3b12084f3bd805895 Mon Sep 17 00:00:00 2001 From: Daniel Silverstone Date: Sun, 1 Jul 2012 13:18:47 +0100 Subject: Transfer current state of netsurfweb as a fresh line of history --- documentation/develop.en | 150 +++ documentation/guide.en | 1514 +++++++++++++++++++++++ documentation/images/back.png | Bin 0 -> 708 bytes documentation/images/bwin.png | Bin 0 -> 48631 bytes documentation/images/cache.png | Bin 0 -> 2047 bytes documentation/images/connect.png | Bin 0 -> 2312 bytes documentation/images/content.png | Bin 0 -> 1005 bytes documentation/images/create.png | Bin 0 -> 656 bytes documentation/images/delete.png | Bin 0 -> 830 bytes documentation/images/dwnld.png | Bin 0 -> 32431 bytes documentation/images/expand.png | Bin 0 -> 631 bytes documentation/images/fonts.png | Bin 0 -> 1209 bytes documentation/images/forward.png | Bin 0 -> 815 bytes documentation/images/history.png | Bin 0 -> 889 bytes documentation/images/home.png | Bin 0 -> 903 bytes documentation/images/homeconf.png | Bin 0 -> 1316 bytes documentation/images/hotlist.png | Bin 0 -> 1121 bytes documentation/images/images.png | Bin 0 -> 1871 bytes documentation/images/interface.png | Bin 0 -> 1857 bytes documentation/images/language.png | Bin 0 -> 2200 bytes documentation/images/launch.png | Bin 0 -> 481 bytes documentation/images/memory.png | Bin 0 -> 1725 bytes documentation/images/open.png | Bin 0 -> 757 bytes documentation/images/print.png | Bin 0 -> 715 bytes documentation/images/reload.png | Bin 0 -> 1091 bytes documentation/images/resinstall/boot.png | Bin 0 -> 9211 bytes documentation/images/resinstall/bootinstall.png | Bin 0 -> 6927 bytes documentation/images/resinstall/configure.png | Bin 0 -> 30836 bytes documentation/images/resinstall/system.png | Bin 0 -> 7308 bytes documentation/images/save.png | Bin 0 -> 782 bytes documentation/images/scale.png | Bin 0 -> 855 bytes documentation/images/search.png | Bin 0 -> 1070 bytes documentation/images/security.png | Bin 0 -> 1858 bytes documentation/images/stop.png | Bin 0 -> 1068 bytes documentation/images/themes.png | Bin 0 -> 2529 bytes documentation/images/up.png | Bin 0 -> 703 bytes documentation/index.en | 209 ++++ documentation/info.en | 140 +++ documentation/nstheme.en | 156 +++ documentation/progress.en | 300 +++++ documentation/resinstall.en | 129 ++ documentation/robuild.en | 107 ++ documentation/roinfo.en | 186 +++ documentation/translations.en | 136 ++ 44 files changed, 3027 insertions(+) create mode 100644 documentation/develop.en create mode 100644 documentation/guide.en create mode 100644 documentation/images/back.png create mode 100644 documentation/images/bwin.png create mode 100644 documentation/images/cache.png create mode 100644 documentation/images/connect.png create mode 100644 documentation/images/content.png create mode 100644 documentation/images/create.png create mode 100644 documentation/images/delete.png create mode 100644 documentation/images/dwnld.png create mode 100644 documentation/images/expand.png create mode 100644 documentation/images/fonts.png create mode 100644 documentation/images/forward.png create mode 100644 documentation/images/history.png create mode 100644 documentation/images/home.png create mode 100644 documentation/images/homeconf.png create mode 100644 documentation/images/hotlist.png create mode 100644 documentation/images/images.png create mode 100644 documentation/images/interface.png create mode 100644 documentation/images/language.png create mode 100644 documentation/images/launch.png create mode 100644 documentation/images/memory.png create mode 100644 documentation/images/open.png create mode 100644 documentation/images/print.png create mode 100644 documentation/images/reload.png create mode 100644 documentation/images/resinstall/boot.png create mode 100644 documentation/images/resinstall/bootinstall.png create mode 100644 documentation/images/resinstall/configure.png create mode 100644 documentation/images/resinstall/system.png create mode 100644 documentation/images/save.png create mode 100644 documentation/images/scale.png create mode 100644 documentation/images/search.png create mode 100644 documentation/images/security.png create mode 100644 documentation/images/stop.png create mode 100644 documentation/images/themes.png create mode 100644 documentation/images/up.png create mode 100644 documentation/index.en create mode 100644 documentation/info.en create mode 100644 documentation/nstheme.en create mode 100644 documentation/progress.en create mode 100644 documentation/resinstall.en create mode 100644 documentation/robuild.en create mode 100644 documentation/roinfo.en create mode 100644 documentation/translations.en (limited to 'documentation') diff --git a/documentation/develop.en b/documentation/develop.en new file mode 100644 index 0000000..9406e3b --- /dev/null +++ b/documentation/develop.en @@ -0,0 +1,150 @@ + + + +NetSurf | Developer Documentation + + + + + + + + + +
+ + + +

Developer Information

+ +

This document contains various information for developers or anyone interested in contributing to NetSurf.

+ + + +

Last updated 11 November 2007

+ +

Source control

+ +

The source is kept in a Subversion repository. To check the source out use the command:

+ +

$ svn checkout svn://svn.netsurf-browser.org/trunk/netsurf

+ +

You can also browse the source via the web interface.

+ +

Recent changes can be seen on the development page. An an RSS feed of recent changes is also provided by CIA. All checkins are reported on the Commits mailing list.

+ +

Contact James to get write access to the SVN repository.

+ + +

Compiling

+ +

The recommended compiler is GCC. A guide to building NetSurf on RISC OS is available, as are instructions for building the GTK version. NetSurf can also be cross-compiled for RISC OS using GCCSDK.

+ +

The autobuilder compiles NetSurf every 15 minutes if changes have been checked into SVN.

+ +

A debug version of NetSurf can be built. This is command-line only and does not include any GUI code. It runs natively on Linux so can be debugged and checked using gdb, efence, valgrind, etc.

+ +

Dependencies

+ +

In addition to the compiler, NetSurf requires a number of additional tools to be available. These are enumerated below. Additionally, the libraries which NetSurf uses are also listed

+ +

Tools

+ + +

Libraries

+ + +
RISC OS specific libraries
+ + + +

Source documentation

+ +

See the Docs directory for source code documentation. Our pictorial Style Guide (single-page PDF) shows our code style.

+ + +

Communication

+ +

The main method of communication between the developers is the #netsurf IRC channel.

+ +

The developers' mailing list is also used for less transient communication.

+ + +

Translations

+ +

Translations of NetSurf to other languages are welcome. No programming knowledge is required, just the ability to use a template editor and a text editor. Please see the translations page for more information.

+ + + + +
+ + +
+ +
+ + + diff --git a/documentation/guide.en b/documentation/guide.en new file mode 100644 index 0000000..48acdec --- /dev/null +++ b/documentation/guide.en @@ -0,0 +1,1514 @@ + + + +NetSurf | User Guide + + + + + + + + + +
+ + + +

Note that this document was written for the RISC OS version of NetSurf.

+ +

User Guide

+ + + +

Last updated 10 November 2007

+ +

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. Adjust clicking on NetSurf's iconbar icon opens the hotlist management window.

+ +

Iconbar Menu

+ +

The iconbar menu contains options which concern the application as a whole.

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

Interactive Help

+ +

Instant on-line help is available throughout the software, in the form of interactive help. This offers quick help information, in bullet point format, about the item under the pointer.

+ +

To use interactive help, suitable software must be running. The program 'Help' is shipped with all RISC OS computers and it can be run from NetSurf's Help > Interactive help menu item.

+ +

Browser Window

+ +

The browser window is used to fetch and display web pages and other content available on the World Wide Web. It can also display files that are stored locally on your computer. The file types that NetSurf can handle include HTML, CSS and various image formats.

+ +

+ +

The area at the top of the browser window is called the toolbar. At the bottom, it can be seen that the horizontal scroll bar does not cover the full width of the window. Next to the horizontal scroll bar, is the status bar. The main section in the middle of the window is the most important part, the content area.

+ +

The content area displays web pages and other material, such as images. Web pages contain hyperlinks (often just called 'links') which can point to another part of the page, to a different page or to any other type of file. Links pointing to types of files that NetSurf doesn't recognise will open a download window. Placing the pointer over a link changes the pointer to a 'clicking hand', to indicate that the item can be clicked on.

+ +

Toolbar

+ +

The section at the top of the window is called the toolbar. It allows quick access to various commonly used features. Many more functions are available through the menus. The toolbar can be customised to contain only the icons you want, in the order you want, in toolbar edit mode. This is covered in the toolbar customisation section. Available icons are listed below.

+ +

+ +

Toolbar Icons

+ +

Back Clicking on this button makes NetSurf go back to the previous page in the local history list. Select click to view the previous page in the current window. Adjust click to view it in a new window. Form information is not resubmitted.

+ +

Forward Clicking on this button allows you to advance through the local history list. Select click to view the next page in the current window. Adjust click to view it in a new window. Form information is not resubmitted.

+ +

History Select clicking on this button opens a window containing the local history tree. Adjust clicking opens the global history window. More detailed information can be found in the History section.

+ +

Home Clicking on this button returns to the configured home page.

+ +

Hotlist Select clicking on this button opens the hotlist management window. Adjust clicking adds the current location to the hotlist.

+ +

Print Clicking on this button will open the print dialogue box.

+ +

reload Select clicking on this button will make NetSurf fetch and redraw the current page again. Adjust clicking forces NetSurf to fetch the current page as well as any objects it contains, such as images and style sheets.

+ +

Save Clicking on this button will open a save dialogue box, to allow you to save the page for future reference.

+ +

Scale Clicking on this button will open the scale view window. It allows you to scale documents, affecting both text and pictures.

+ +

Search Clicking on this button opens the find text window. It allows you to search for a string of text within a document.

+ +

Stop Clicking on this button stops whatever process the window is doing.

+ +

Up Clicking on this button moves up the directory tree. For example, if you are looking at http://www.domain.com/directory/page.html, clicking on the up icon takes you to http://www.domain.com/directory/ and a further click would result in a location of http://www.domain.com/.

+ +

Icons that are greyed out indicate that their function is unavailable. This happens when a new browser window is first opened. Since the window will be displaying its first page, there would be no previous page and the back button is greyed out. Also, as this is the first page, the forward button is also greyed out.

+ +

Throbber: This NetSurf logo animates while a page is downloading or rendering. It indicates that NetSurf is doing something.

+ +

URL Bar

+ +

The white writable icon on the toolbar is called the URL Bar and it shows the location of the current page. Here, you can enter the address of the page you want to view next. Text files dropped onto the URL bar are treated as URLs.

+ +

Next to the URL bar is a pop-up menu button which opens a list of URLs previously typed into the URL bar. Clicking on one of the URLs opens the page.

+ +

The current URL can be dragged from the URL bar to be saved or dropped onto other applications. A Ctrl drag saves the URL in Text format and a Shift drag saves it in ANT URL format. Systems that don't support text selection in writable icons (i.e. non RISC OS Select systems) allow the URL to be dragged out in Text format without the use of either Ctrl or Shift.

+ +

URL Completion

+ +

When typing into the URL bar, NetSurf opens a window below displaying suggestions for the full address. If the address you want is not shown, the box can be ignored. If the intended address is shown, select clicking on it will complete the address and open the page automatically. An adjust click on a URL copies it into the URL but does not load the page. The Up and Down cursor keys can be used to select an address from the list and the Return key opens the page. Escape closes the URL completion window. The function of other keys in the URL bar, such as the Left and Right cursor keys, is unaffected by this feature.

+ +

Status Bar

+ +

The status bar, at the bottom of the window, displays information to the user. When you move the pointer over a link, the status bar will display the URL that the link points to. The status bar also displays information about NetSurf's progress while retrieving a page.

+ +

Between the status bar and the horizontal scroll bar is the status bar resizer. Over this widget, the pointer changes to a double headed arrow and you can drag the status bar resizer to set the width of the status bar.

+ +

Content Area

+ +

The content area is the main part of the browser window; it displays documents and images. Various types of action can be performed in the content area, including:

+ + + +

Some operations, such as a dragging and clicking will behave differently depending on the content over which the action is carried out. For example, dragging over text initiates text selection whereas dragging over non-textual content will drag-scroll the page.

+ +

Further options are available through the menu, some of which are only available when menu is clicked over certain types of content. For example the Object submenu is available only when menu is clicked over an object, such as an image.

+ +

Text Selection

+ +

Textual content on pages can be selected and copied. Text in text areas can be selected and then cut or copied to the global clipboard. The global clipboard contents can also be pasted into text areas.

+ + + +

Ctrl+C copies selected text to the global clipboard. Ctrl+A selects all text, while Ctrl+Z clears the selection.

+ +

Drag Scrolling

+ +

The page can be scrolled by dragging non-textual areas up and down. During a drag scroll action, the pointer changes to a hand.

+ + + +

Link Handling

+ + + + + +

Drag Saving

+ +

Content can be dragged directly from the page to a filer window with the Ctrl key.

+ + + +

Different items are treated as follows.

+ + + + + +

Form Completion

+ +

Forms allow information to be entered and submitted to an agent such as a web server or mail server. Some form controls can be styled by web pages, so they may look quite different from one page to the next. Some common form controls are described below.

+ +
+
Buttons
+
Buttons trigger some action when selected. Common button actions are to submit or reset the form.
+ +
Checkboxes
+
Checkboxes are on/off switches that can be toggled. Checkboxes containing a red square are "on".
+ +
Radio Buttons
+
Radio buttons are like checkboxes except that groups of radio buttons are mutually exclusive: when one is switched "on", all others with the same name are switched "off". Radio buttons containing a red circle are "on".
+ +
Selection Menus
+
Selection menus open a menu, from which an item, or in some cases several items, can be selected. Selected items are displayed with a tick (✓) next to them. The pointer changes to indicate a pop-up menu is available over selection menu controls.
+ +
TextInput
+
A text input allows a single line of text to be entered and edited. Pressing Return in a text input will submit the form.
+ +
File Input
+
File inputs say "Drop file here" and allow local files to be submitted. Dragging a file to them sets the path to the file.
+ +
Text Area
+
Text areas are similar to text inputs but they allow multiple lines to be edited. Pressing Return in a text area moves the caret to the next line.
+
+ +

Tab can be used to move the caret to the next text input or text area control. Shift+Tab moves input focus back to the previous text box.

+ +

Menus

+ +

The browser window menu contains options relating to the content of the current window. Some of these options are unavailable at present as this area of NetSurf is not complete. The following options are available:

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

The Page submenu contains the following options relevant to the current page.

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

The Object submenu contains the following options relevant to the current object. This submenu is only available when the pointer is placed over an object such as a link or an image.

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

The selection submenu contains the following options, for manipulating the current selection and performing clipboard actions.

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

The Navigate submenu contains the following options, useful for navigating the web.

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

The Display submenu contains the various options which affect the rendering of the current window. Other configuration options are described in the configuration section.

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

If the buttons, URL bar and throbber are all disabled, the toolbar at the top of the window is removed, leaving more space for the main content area.

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

The Utilities submenu allows you to access some of NetSurf's extra features.

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

The Help submenu contains options for fast access to help and information while you're using NetSurf.

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

File Types

+ +

When NetSurf encounters a file type it does not recognise, it opens a download window to allow the file to be saved to disc. (Note, NetSurf ignores local files of unrecognised file types.) The file types that NetSurf understands are listed below, with their RISC OS file type and MIME type(s) .

+ + + + + + + + + + + + + + + + + + +
NameTypeMIME type(s)
Acorn URI&f91N/A
ANT URL&b28N/A
CSS&f79text/css
Drawfile&affapplication/drawfile
application/x-drawfile
image/drawfile
image/x-drawfile
Flash&188application/x-shockwave-flash
GIF&695image/gif
HTML&faftext/html
IEURL&1baN/A
JNG&f78image/jng
image/x-jng
JPEG&c85image/jpeg
image/pjpeg
MNG&f83image/mng
image/x-mng
video/mng
video/x-mng
NetSurf ThemeN/Aapplication/x-netsurf-theme
PNG&b60image/png
Sprite&ff9image/x-riscos-sprite
Text&ffftext/plain
+ +

Flash files are not handled by NetSurf directly but are displayed by an external plugin.

+ +

NetSurf recognises different file types by their RISC OS file type for local files and by their content-type header for files sourced from the internet. Files are not identified by their extension or content. This means that for a file to be displayed, servers must be configured to send the correct content-type header and local files must have the correct RISC OS file type set.

+ +

Download Window

+ +

Whenever you follow a link to a file that NetSurf doesn't know how to handle, NetSurf opens the download window. This allows you to save a local copy of the file. The download window is shown below.

+ +

+ +

As soon as the download window opens, NetSurf starts downloading the file to your Scrap directory. At any time, either as the file downloads or after it has finished, it is possible drag the file icon at the top of the window to the directory where you wish to keep the file. This action causes the file to be moved to your desired location from Scrap and if the download is incomplete, the remainder of the file will also go to the new location.

+ +

The Source field indicates the location of the file being downloaded.

+ +

Initially, the Destination field allows the local filename of the file being downloaded to be set. Once the local destination of the file has been set, by dragging the icon to a filer window, the local path is shown here. Clicking on it will open the associated directory.

+ +

The bottom part of the download window displays information about the download's progress. On the left, the amount already downloaded and the total size are displayed. In the middle, the download speed is indicated and that the right, and estimated time remaining is shown. A beige progress bar indicates the download's progress visually.

+ +

History

+ +

While browsing the World Wide Web, you may come across interesting pages and some time later, you may wish to return to them. NetSurf's history stores the addresses (URLs) of the web pages you visit so that you can return to a page without having to remember the URL or how you first came across it.

+ +

NetSurf supports two distinct types of history; local and global. Local history contains only the pages that are visited in any particular window. Global history contains all the pages that have been visited in NetSurf and is remembered when NetSurf is restarted.

+ +

Local History Window

+ +

NetSurf's local history window provides a diagrammatical overview of the browsing history of a particular window. Each web page that is visited is represented by a thumbnail in a tree diagram. Beneath each thumbnail the page title is shown. Clicking on a thumbnail will cause the NetSurf browser window to return to that particular page.

+ +

Global History Window

+ +

NetSurf's global history stores the addresses (URLs) of all the web pages you visit. To open the global history window, you can adjust click on the history toolbar button on a browser window, use the browser window menu option or use the iconbar menu. The global history is made up from "addresses" and "directories".

+ +

An address consists of a name and a URL. Addresses in the global history can point to any kind of file and double clicking on one will launch the URL in NetSurf. Addresses also store the date the URL was visited. By default, addresses are listed in the order they were visited and they are grouped by date within directories.

+ +

Directories store groups of addresses. In the default global history view, there are directories for each day up to the beginning of last week and further directories for previous weeks. The global history is expired after a maximum of four weeks.

+ +

The global history display works in a similar way to a filer window, although there are some important differences. Directories are not opened in new windows. Instead, the whole of the history is displayed in one window and directories represented by branches in a tree diagram. Double clicking on a closed directory will open it, displaying its contents as a new branch. Double clicking on an open directory will close it. When addresses are double clicked on, their URL is launched by NetSurf.

+ +

Next to the address and directory icons there are toggle boxes, which can be used to expand and collapse branches in the history tree. Clicking on the branch toggle boxes next to directories has exactly the same effect as double clicking on a directory. Expanding an address with the branch toggle box displays the other information it contains. (The URL and the time it was visited.) The space bar can also be used to expand or collapse selected addresses.

+ +

As with filer windows, selections can be made by dragging selection boxes and adjust clicking can be used to add or remove items from the selection.

+ +

Toolbar

+ +

The global history toolbar allows quick access to various commonly used features. More functions are available through the menus. The toolbar can be customised to contain only the icons you want, in the order you want, in toolbar edit mode. This is covered in the toolbar customisation section. Available icons are listed below.

+ +

Delete Selection Clicking on this button deletes any selected directories or addresses from the global history.

+ +

Expand Addresses Select clicking on this button expands any addresses that are being shown, to display additional information about each one. Adjust clicking hides the additional information for any expanded addresses.

+ +

Launch Selection Clicking on this button launches all selected addresses in separate browser windows. If a directory is selected any addresses it contains will be launched.

+ +

Open Directories Select clicking on this button opens every directory in the global history. Adjust clicking closes any open directories.

+ +

Menus

+ +

The global history menu contains options which allow you to manage the content of your global history. The options available are:

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

The History submenu contains the following options which apply to the global history window in general.

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

The selection submenu, which is only available when a selection has been made in the global history window, contains the following options.

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

Hotlist Management Window

+ +

While browsing the World Wide Web, you may come across pages that you wish to return to. NetSurf's hotlist provides a convenient way of storing these addresses (URLs) so that you can return to the page without having to remember the URL or how you first came across the page. To open the hotlist management window, you can adjust click on NetSurf's iconbar icon or select click on the Hotlist toolbar button in a browser window. Hotlists are made up from "addresses" and "directories". There can be as many of each of these as you like.

+ +

An address consists of a name and a URL. Hotlist addresses can point to any kind of file and double clicking on one will launch the URL in NetSurf. The name can be anything but, for web pages, it is set to the page title by default. The simplest way to add an address to the hotlist is to adjust click on the Hotlist toolbar button in a browser window. This adds the URL of the current page to the hotlist. Additionally, files on your hard disc can be added by dragging them to the hotlist from a filer window. Addresses also store other usage information, such as the date the address was added to the hotlist, when it was last visited and how many times it has been visited in total.

+ +

Directories are used to group related addresses to allow for easy location of the address you want. They can be nested and contain a mixture of addresses and other directories.

+ +

The hotlist display works in a similar way to a filer window, although there are some important differences. Directories are not opened in new windows. Instead, the whole hotlist is displayed in one window and directories represented by branches in a tree diagram. Double clicking on a closed directory will open it, displaying its contents as a new branch. Double clicking on an open directory will close it. When addresses are double clicked on, their URL is launched by NetSurf.

+ +

Next to the address and directory icons there are toggle boxes, which can be used to expand and collapse branches in the hotlist tree. Clicking on the branch toggle boxes next to directories has exactly the same effect as double clicking on a directory. Expanding an address with the branch toggle box displays the other information it contains, such as the URL and its usage statistics. The space bar can also be used to expand or collapse selected addresses.

+ +

As with filer windows, selections can be made by dragging selection boxes and adjust clicking can be used to add or remove items from the selection. Selections can then be dragged and dropped within the hotlist management window to move them around. It is possible to drop a selection into a closed directory by releasing it over the bottom half of the target directory. Dropping the selection over the top half of a directory or address will insert the selection above that item. Finally, dropping a selection over the lower half of an address will move it below the address.

+ +

Renaming of addresses and directories can by achieved by clicking on an item with the Alt key held down. The URLs within expanded address entries can also be altered in this way. Selected items can be deleted from the toolbar, menus or with Ctrl+X

+ +

NetSurf's hotlist is stored as an HTML file which can be found in Choices:WWW.NetSurf. This means the hotlist file can be loaded into a NetSurf browser window and used as a links page or set to your default home page. The hotlist file is saved when you quit NetSurf.

+ +

Toolbar

+ +

The hotlist toolbar allows quick access to various commonly used features. More functions are available through the menus. The toolbar can be customised to contain only the icons you want, in the order you want, in toolbar edit mode. This is covered in the toolbar customisation section. Available icons are listed below.

+ +

Toolbar Icons

+ +

Create Directory Clicking on this button adds a new directory to the bottom of the hotlist. The cursor is placed at the name of the new directory. Either type Ctrl-U and rename it or press Return to accept the default name.

+ +

Delete Selection Clicking on this button deletes any selected directories or addresses from the hotlist.

+ +

Expand Addresses Select clicking on this button expands any addresses that are being shown, to display additional information about each one. Adjust clicking hides the additional information for any expanded addresses.

+ +

Launch Selection Clicking on this button launches all selected addresses in separate browser windows. If a directory is selected any addresses it contains will be launched.

+ +

Open Directories Select clicking on this button opens every directory in the hotlist. Adjust clicking closes any open directories.

+ +

Icons that are greyed out indicate that their function is unavailable.

+ +

Menus

+ +

The hotlist menu contains options which allow you to manage the content of your hotlist. The options available are:

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

The Hotlist submenu contains the following options which apply to the hotlist in general.

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

The selection submenu, which is only available when a selection has been made in the hotlist management window, contains the following options.

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

Addresses added to the hotlist from a NetSurf browser window have a default name set. For HTML files, this is the page title.

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

Configuring NetSurf

+ +

NetSurf can be tailored to suit your needs by configuring the way it looks and behaves. Most of NetSurf's configuration options are available from the global choices panel. Display options for browser windows are set up for an individual browser window and then saved globally in the browser window menus.

+ +

Toolbars can be customised to contain only the icons you want, in the order you want, in toolbar edit mode. This is covered in the toolbar customisation section.

+ +

Global Configuration

+ +

The configuration panel is opened from the iconbar menu.

+ +
+ + +

NetSurf's global configuration sections

+
+ +

Clicking on one of the section icons will open a new configuration window, allowing you to set up that particular aspect of NetSurf.

+ +

All of NetSurf's configuration section windows have the following three buttons at the bottom.

+ +
+
+
Default
+
This button can be used to reset NetSurf's options, for the current configuration window, to the original values that are built into NetSurf. Use this button if you think that you have configured something wrongly and want to try the "factory settings".
+
Cancel
+
Select clicking on this button will close the window. Any changes you have made will be discarded.
Adjust clicking on this button will return all the options in the window back to the last saved values, that were shown when you opened the window.
+
Set
+
Select clicking on this button will save your changes and close the window.
Adjust clicking on this button will save your changes and leave the window open.
+
+
+ +

Cache Configuration

+ +

NetSurf keeps local copies of some content, which has been downloaded from the internet. This local copy of downloaded data is called a cache and it improves NetSurf's performance. The cache is used so that if, for example, you visit a page that contains an image and then go to another page that uses the same image, NetSurf will not need to download the same image twice.

+ +

NetSurf has two separate caches, the memory cache and the disc cache.

+ +
Memory cache
+ +

The memory cache is used to store data related to the most recent pages you have seen. Since this data is stored in memory, it can be accessed very quickly. The memory cache is not preserved over sessions, and is lost when you quit NetSurf.

+ +
+
+
Size
+
This option can be used to alter the size of NetSurf's memory cache. A larger cache will allow more content to be stored in memory, at the expense of greater memory usage.
+
+
+ +
Disc cache
+ +

The disc cache is used to store content from web sites on your computer's hard disc. This allows you to return to old pages without having to download them again. The disc cache also stores other persistent data (data that is recovered next time you start NetSurf). It stores web page thumbnails for showing in global history.

+ +
+
+
Duration
+
This option can be used to alter the maximum length of time data will stay in the disc cache, without being used, before it is dropped from the cache. Note that files are not automatically deleted from your hard disc when they are dropped from the cache. Files in the cache are each assigned a file name. When the file is dropped from the cache its file name is freed up, so that a new file to be written to the cache can overwrite it. NetSurf does not automatically delete dropped files for performance reasons and to keep hard disc usage to a minimum. To manually delete dropped files, use the "perform maintenance button below.
+
Perform maintenance
+
This button can be used to delete any redundant files from NetSurf's disc cache.
+
+
+ +

At the current time the disc cache is not fully operational. It is only used for storing images.

+ +

Connection Configuration

+ +

NetSurf accesses the internet by contacting remote computers. The options here can be used to configure how it does this.

+ +
HTTP Proxy
+ +

Some computers need to be connected to the internet through a proxy server. If your Internet Service Provider has a proxy server, the details can be entered here.

+ +
+
+
Proxy type
+
This option can be used to select a proxy type. "No proxy" means you do not require a proxy to connect to the internet. "Simple proxy" means use a proxy that does not require authentication (a username and password). "Basic authentication" means use a proxy that requires a username and password. "NTLM authentication" also means use a proxy that requires a username and password. Consult your ISP to find out which option to use. If a proxy is required, "Simple proxy" is the most common type.
+
Host
+
This option can be used to set the host name for the proxy server. This option will be greyed out if "No proxy" has been selected above.
+
Port
+
This option can be used to set the port number for the proxy server. This option will be greyed out if "No proxy" has been selected above.
+
Username
+
This option can be used to set a username for use with the proxy server. This option will be greyed out unless a proxy with authentication has been selected for the proxy type.
+
Password
+
This option can be used to set a password for use with the proxy server. This option will be greyed out unless a proxy with authentication has been selected for the proxy type.
+
+
+ +
Fetching
+ +

The way NetSurf fetches content from the internet can be tailored to suit your hardware and the speed of your internet connection. These are quite advanced configuration options and should not need to be modified, in most cases.

+ +
+
+
Maximum fetches
+
This option can be used to set the maximum number of simultaneous fetches (downloading multiple things in parallel) that NetSurf will carry out at one time. After this limit is reached, new fetches will be queued and fetched as the current fetches are completed. High values will benefit people with fast connections and fast computers, that are able to keep up with all the incoming data.
+
Fetches per host
+
This option can be used to set the maximum number of simultaneous fetches per host. This means the limit to the number of simultaneous downloads from a particular web site. Simultaneous downloads from the same host can speed up fetching web pages quite dramatically because images on the page can be fetched in parallel, rather than in series.
+
Cached connections
+
This option can be used to set the maximum number of persistent connections that NetSurf can maintain at any one time. Persistent connections, or "Keep-Alive" connections are HTTP sessions that allow multiple requests to be sent over the same connection. In some cases they have been shown to result in an almost 50% speed up in latency times for HTML documents with lots of images.
+
+
+ +

Content Configuration

+ +

Content is the name given to material downloaded from the World Wide Web. It can be web pages, images, animations and more.

+ +
Content blocking
+ +

NetSurf can prevent certain types of content from loading and stop pages from performing certain actions.

+ +
+
+
Hide advertisements
+
This option can be used to stop NetSurf from displaying advertisements on web pages. This can be useful for pages which contain distracting or obtrusive adverts. Note that NetSurf can only make an educated guess at which content is an advert and which is not. This can mean that some adverts will be fail to be blocked, or more seriously, when advertisement blocking is enabled some valid content may occasionally be blocked.
+
Disable pop-up windows
+
This option can be used to stop web pages from opening new browser windows on your desktop. Some pages may try to open advertisements in new windows, when you visit the page, or open some links in pop-up windows, instead of the current window. Disabling pop-ups means that the only way a new window can be opened is when a user explicitly opens it.
+
Disable plug-ins
+
This option can be used to disable plug-ins. Plug-ins are external applications that can handle specific types of content, for example Flash files. This option disables the use of plug-ins, meaning that NetSurf will simply not display the particular file, or use any alternative content provided by a web page.
+
+
+ +

Font Configuration

+ +

Most content and information on the World Wide Web is text. It is important to set NetSurf up so that it displays text that you find comfortable to read.

+ +
Font faces
+ +

You can set which specific font on your system that you want NetSurf to use for each of the five styles of typeface that are available for use on the World Wide Web.

+ +
+
+
Sans-serif
+
This option can be used to select a particular sans-serif font on your system. It will be used whenever a web page specifies a sans-serif typeface. Helvetica (Homerton) is an example of a sans-serif font.
+
Serif
+
This option can be used to select a particular serif font on your system. It will be used whenever a web page specifies a serif typeface. Times (Trinity) is an example of a serif font.
+
Monospace
+
This option can be used to select a particular monospace font on your system. It will be used whenever a web page specifies a monospace typeface. Courier (Corpus) is an example of a monospace font.
+
Cursive
+
This option can be used to select a particular cursive font on your system. It will be used whenever a web page specifies a cursive typeface. ZapfChancery (Churchill) is an example of a cursive font.
+
Fantasy
+
This option can be used to select a particular fantasy font on your system. It will be used whenever a web page specifies a fantasy typeface. There is no particular style of font associated with fantasy, so any fancy looking but readable font would be apt and suitable.
+
Default
+
This option can be used to set the default font style. It is used when web pages do not specify a font face of their own. Sans-serif and serif are the most typical options for this setting.
+
+
+ +
Font size
+ +

The size of text used to render web pages can be controlled with the following options. It is important to ensure that the text NetSurf renders is at a size you find comfortable to read.

+ +
+
+
Default
+
This option can be used to set the default font size. The default font size is the size at which text will be rendered whenever web pages do not specify a size. It is also the base size that is used where web sites specify relative font sizes.
+
Minimum
+
This option can be used to set the minimum font size. No text will be rendered smaller than this size, even if a web site specifies a smaller size. This option is used to ensure that web pages are never rendered with smaller text than you find easy to read.
+
+
+ +

Home Page Configuration

+ +

The home page is the page that is opened when you open a new window from the icon bar.

+ +
Home page
+ +
+
+
URL
+
This option can be used to set NetSurf's home page address. Any address can be typed into the box, or an address can be selected from a menu of recently visited URLs. These URLs are addresses that have previously been typed into the URL bar of a NetSurf browser window.
+
Open browser window on start-up
+
This option can be used to make NetSurf open a new browser window on the desktop, when the application is started.
+
+
+ +

Image Configuration

+ +

A great deal of content on the internet is in the form of images. NetSurf allows the display of images to be tailored to suit the hardware you use.

+ +
Image quality
+ +

NetSurf can use various different methods to display images on web pages. If you are using NetSurf in a 16 million colour screen mode, all the options will perform the same. If you use less than 16 million colours then there is a trade-off between image quality and rendering speed. The exception to this is the "Use OS" option, which will never display images with alpha channels (varying degrees of transparency) as well as any of the other options. The four image quality settings are described below.

+ +
+
Use OS
+
This means that RISC OS's routines (OS_SpriteOp) are used to display images. This option results in poor quality (especially so for images with alpha channels as the alpha channel is emulated using standard calls) and also poor speed. This option is not recommended unless you are having problems with the other options.
+
Direct to screen
+
This is the fastest available output, but suffers the same low quality as using the OS routines in less than 16 million colours. However, this option can render images with alpha channels correctly. If you are on a slow machine you may want to use this for background images.
+
Dithered
+
This is a quick method for improving the display of images in screen modes with less than 16 million colours. It emulates twice as many colours as are available in the current screen mode (for less than 16 million colours). It gives a fair increase in display quality for many images and you won't notice much speed loss. If you're on a slow machine you will probably find this best for foreground images.
+
Error diffused
+
This is another method for improving the display of images in screen modes with less than 16 million colours. It is slower than dithering but offers the highest quality representation of images. If you run in an 8bpp (256 colour) screen mode then this is as aesthetically pleasing as you can get. As it is slower than the other options, you may only want to use it for foreground images, even on a medium powered machine (such as a SA RiscPC).
+
+ +

Note that if you are using a 16 million colour mode then neither error diffusion or dithering will be used, even if one of these options is selected. This is because all possible colours can be displayed directly. Naturally, use of a 16 million colour million colour screen mode gives the best possible display, if you have the image quality setting set to "Direct to screen", "Dithered" and "Error diffused". If you use 16 million colours and have a fast machine, it is best to use "Error diffused", so that if you ever drop to a low colour screen mode you still get the best available image quality.

+ +
+
+
Foreground
+
This option can be used to set the type of rendering to be used for foreground images. Since foreground images are often important features of web pages and cover relatively small areas, it is worth setting this setting as high as you can get away with on your hardware. For details on what each of the options actually does, see the notes above.
+
Background
+
This option can be used to set the type of rendering to be used for background images. Since background images are rarely vital features of web pages and can cover large areas, it would be wise to set this setting to a lower quality than for foreground images, if you are not running NetSurf on one of the latest machines. For details on what each of the options actually does, see the notes above.
+
Preview image
+
This section shows the results of your image quality choices on the visual appearance of images. In 16 million colour screen modes, the "Direct to screen", "Dithered" and "Error diffused" will look the same. If the "Use OS" option is used for the foreground image, the preview will demonstrate the poor handling of alpha channels that this mode exhibits. In 256 colour modes, the differences between the different quality settings should be quite pronounced.
+
+
+ +
Animations
+ +

Some web pages use animations, which are a series of still images played in sequence.

+ +
+
+
Speed limit
+
This option can be used to set the minimum time delay between displaying each frame of an animation. Increasing this value will cause animations to run slower. Fast animations require a lot of computational effort, so a very low setting can cause your computer to slow down when rapid animations are displayed.
+
Disable animations
+
This option can be used to stop animations from being played. If animations are disabled then the first frame of the animation is shown as a static image.
+
+
+ +

Interface Configuration

+ +

The way NetSurf interacts with its users is called its interface. Various aspects of NetSurf's behaviour can be tailored to suit your requirements.

+ +
Downloading / saving files
+ +

You can use NetSurf to save content from the internet onto your local hard disc.

+ +
+
+
Strip filename extensions when saving
+
This option can be used to remove the file extensions (eg .html and .jpeg) from file names. The extensions are not needed on RISC OS as it records the file type by other means. You may want to retain file extensions if you plan to transfer saved files to other computers, running different operating systems.
+
Request confirmation before overwriting files
+
This option can be used to make NetSurf to ask for confirmation before overwriting a file of the same name, when saving. Please note that NetSurf does not allow directories to be overwritten. Also note that SparkFS causes zip files and other archives to be treated as directories.
+
+
+ +
Interactive features
+ +

NetSurf has various features that can provide information and additional functionality as you use or interact with the program.

+ +
+
+
Display recently visited URLs as you type
+
This option can be used to enable NetSurf's URL suggestion feature. When this is enabled and you type into the URL bar of a NetSurf browser window, then a small window is opened up below the URL bar, which shows previously visited URLs that could be used to complete the URL you're typing. For more information, see the URL completion section.
+
Hover URLs by the pointer for local history
+
This option can be used to make NetSurf display the URL of the thumbnail under your mouse pointer in local history windows. The URL is displayed in a floating box, beside the pointer.
+
+
+ +

Language Configuration

+ +

NetSurf has been designed to work in different languages and you can select the one that you find most suitable.

+ +
Language
+ +
+
+
Interface
+
This option can be used to select the language to use for NetSurf's interface. This includes menus, dialogue boxes and interactive help text. The only available languages are those that have had resources prepared for them. At the current time, these are English, Dutch, French and German.
+
Web pages
+
This option can be used to request for web pages to be sent in your preferred language. Some web sites are available in a variety of languages. NetSurf will request that web servers send pages in the language of your choice. If your desired language is unavailable, the server will ignore the request and use a default language.
+
+
+ +

Memory Configuration

+ +

NetSurf provides you with a certain amount of control over how it uses the memory on your system. The way you set up NetSurf's memory usage will depend on how much memory your system has and how many other applications you tend to have running while browsing the World Wide Web.

+ +
Image memory
+ +

NetSurf uses memory to store images downloaded from the internet, while you are viewing them. It can store both compressed and uncompressed images in memory.

+ +
+
+
Direct
+
This option can be used to set the maximum amount of memory NetSurf will use for storing uncompressed images. The more memory you allocate to this, the more images NetSurf will be able to hold in memory. Uncompressed images, held in memory can be displayed very quickly.
+
Automatic handling
+
This option can be used to tell NetSurf to make an intelligent guess at the best amount of memory to use for uncompressed images on your system. Generally, this option will work well for most users.
+
Compressed
+
This option can be used to set the maximum amount of memory NetSurf will use for storing compressed images. The more memory you allocate to this, the more images NetSurf will be able to hold in memory. Uncompressed images, held in memory, can be displayed quickly. When the "direct" and "compressed" memory is full, images can be dropped out of memory and stored on your hard disc. This is part of NetSurf's disc cache functionality and options for controlling this are provided in the cache configuration section.
+
Automatic handling
+
This option can be used to tell NetSurf to make an intelligent guess at the best amount of memory to use for compressed images on your system. Generally, this option will work well for most users.
+
+
+ +

Security Configuration

+ +

As the World Wide Web has grown in popularity, so too has the number of people who try to exploit its users for some nefarious end. Browser security and privacy features have become increasingly important.

+ +
Cross-site privacy
+ +

When you visit one page, after following a link on another page, a browser can tell the new page the address of the page that linked to them.

+ +
+
+
Send site referral information
+
This option can be used to allow NetSurf to send referral information. When this option is disabled, NetSurf will not tell web sites the address of the page you came from. In most cases this should not cause any problems, but some sites do require you to send referral information. In these cases you might find images don't load or you get Forbidden messages from their server. On the other hand, if you do send referral information, web sites will be able to tell what web site you were at before you followed a link to their site. This allows them to find out what other sites are linking to them and is not usually any cause for distress.
+
+
+ +
Site history
+ +

NetSurf records all the web sites you have visited as part of its global history feature. Entries can be deleted from the global history window directly and NetSurf allows the length of time items are kept in global history to be configured.

+ +
+
+
Duration
+
This option can be used to set the length of time entries are stored in global history, before they are deleted. Setting the duration to zero days turns off the global history feature.
+
+
+ +

Theme Configuration

+ +

The 'look and feel' of NetSurf's interface can be changed. This is done by installing and selecting themes.

+ +
Available themes
+ +

This section displays a preview of all the currently installed themes. New themes are available at the NetSurf themes page.

+ +
+
+
Theme selection pane
+
This section can be used to select a theme. A theme is selected using the radio buttons. If a theme you have just installed does not appear for selection, NetSurf needs to be told to re-scan the themes directory. It is re-scanned when the choices window is opened or by adjust clicking on the Cancel button. The currently loaded theme is cached so any updates to that theme will not be loaded until NetSurf is restarted. Alternatively, it is possible to switch to another theme, re-scan themes and then switch back.
+
+
+ +

Toolbar customisation

+ +

Icons on NetSurf's toolbars can be switched on & off and moved around. The sprites used for the icons can be changed by installing different themes.

+ +

To move the icons around, enable toolbar edit mode by clicking menu over the toolbar and choosing "Edit toolbar". This will open the toolbar editing panel. Icons can be dragged back and forth between the temporary panel and the toolbar. Separators for groups of icons can be created by dragging the separator sprite from the toolbar edit panel and dropping it where you want it to go. To exit toolbar edit mode, select "Edit toolbar" again from the toolbar menu.

+ +

When you exit toolbar edit mode, the new toolbar layout is saved and new windows opened from then on will use your customised 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.

+ +

Content

+ + + + + + + + + + + +
ShortcutFunction
Ctrl+NOpen the current page in a new window
Ctrl+F1Display information about the current page or content
F3Save the page source
Ctrl+F3Save the page as text
Shift+F3Full save of the web page, including images etc
Ctrl+Shift+F3Save the page as a Drawfile
F8View the page source code in a text editor
PrintOpen the print dialogue box
+ +

Display

+ + + + + + + + + + + + + + + +
ShortcutFunction
Page DownScroll down by one page
Page UpScroll up by one page
Cursor DownScroll down one line
Ctrl+Cursor DownGo to the bottom of the page
Cursor UpScroll up one line
Ctrl+Cursor UpGo to the top of the page
F11Open the scale view window
Ctrl+QReduce scale of view
Ctrl+WIncrease scale of view
Ctrl+Shift+QReduce scale of view by 10%
Ctrl+Shift+WIncrease scale of view by 10%
Shift+F11View box outlines. This may be useful if you are creating your own web page. Cyan marks the content's edge, magenta marks the padding's edge and yellow marks the margin's edge.
+ +

Navigation

+ + + + + + +
ShortcutFunction
F5Reload the current page
Ctrl+F5, Ctrl+RReload the current page and any images and style sheets that the page uses
EscStop the current page loading
+ +

General

+ + + + + + + + + +
F1Open the documentation contents page in a new window
F2Move the caret to URL bar and clear it to "www."
F4Open the text search window
F6Open the hotlist management window
F7Open the local history window
Ctrl+F7Open the global history window
Ctrl+F2Close the window
+ + + + +
+ + +
+ +
+ + + diff --git a/documentation/images/back.png b/documentation/images/back.png new file mode 100644 index 0000000..6f69a3d Binary files /dev/null and b/documentation/images/back.png differ diff --git a/documentation/images/bwin.png b/documentation/images/bwin.png new file mode 100644 index 0000000..1ebb0e8 Binary files /dev/null and b/documentation/images/bwin.png differ diff --git a/documentation/images/cache.png b/documentation/images/cache.png new file mode 100644 index 0000000..dc3099a Binary files /dev/null and b/documentation/images/cache.png differ diff --git a/documentation/images/connect.png b/documentation/images/connect.png new file mode 100644 index 0000000..2cc1c5d Binary files /dev/null and b/documentation/images/connect.png differ diff --git a/documentation/images/content.png b/documentation/images/content.png new file mode 100644 index 0000000..510a079 Binary files /dev/null and b/documentation/images/content.png differ diff --git a/documentation/images/create.png b/documentation/images/create.png new file mode 100644 index 0000000..2ed42f6 Binary files /dev/null and b/documentation/images/create.png differ diff --git a/documentation/images/delete.png b/documentation/images/delete.png new file mode 100644 index 0000000..c6d5f90 Binary files /dev/null and b/documentation/images/delete.png differ diff --git a/documentation/images/dwnld.png b/documentation/images/dwnld.png new file mode 100644 index 0000000..04be6b3 Binary files /dev/null and b/documentation/images/dwnld.png differ diff --git a/documentation/images/expand.png b/documentation/images/expand.png new file mode 100644 index 0000000..de66b94 Binary files /dev/null and b/documentation/images/expand.png differ diff --git a/documentation/images/fonts.png b/documentation/images/fonts.png new file mode 100644 index 0000000..70814f4 Binary files /dev/null and b/documentation/images/fonts.png differ diff --git a/documentation/images/forward.png b/documentation/images/forward.png new file mode 100644 index 0000000..42f022a Binary files /dev/null and b/documentation/images/forward.png differ diff --git a/documentation/images/history.png b/documentation/images/history.png new file mode 100644 index 0000000..f7170ce Binary files /dev/null and b/documentation/images/history.png differ diff --git a/documentation/images/home.png b/documentation/images/home.png new file mode 100644 index 0000000..3cae6ab Binary files /dev/null and b/documentation/images/home.png differ diff --git a/documentation/images/homeconf.png b/documentation/images/homeconf.png new file mode 100644 index 0000000..ec9fbb5 Binary files /dev/null and b/documentation/images/homeconf.png differ diff --git a/documentation/images/hotlist.png b/documentation/images/hotlist.png new file mode 100644 index 0000000..8fca67b Binary files /dev/null and b/documentation/images/hotlist.png differ diff --git a/documentation/images/images.png b/documentation/images/images.png new file mode 100644 index 0000000..13560fe Binary files /dev/null and b/documentation/images/images.png differ diff --git a/documentation/images/interface.png b/documentation/images/interface.png new file mode 100644 index 0000000..329c8d3 Binary files /dev/null and b/documentation/images/interface.png differ diff --git a/documentation/images/language.png b/documentation/images/language.png new file mode 100644 index 0000000..70d91f3 Binary files /dev/null and b/documentation/images/language.png differ diff --git a/documentation/images/launch.png b/documentation/images/launch.png new file mode 100644 index 0000000..68724ed Binary files /dev/null and b/documentation/images/launch.png differ diff --git a/documentation/images/memory.png b/documentation/images/memory.png new file mode 100644 index 0000000..00cd1cd Binary files /dev/null and b/documentation/images/memory.png differ diff --git a/documentation/images/open.png b/documentation/images/open.png new file mode 100644 index 0000000..bf026b4 Binary files /dev/null and b/documentation/images/open.png differ diff --git a/documentation/images/print.png b/documentation/images/print.png new file mode 100644 index 0000000..2b7aad3 Binary files /dev/null and b/documentation/images/print.png differ diff --git a/documentation/images/reload.png b/documentation/images/reload.png new file mode 100644 index 0000000..a98d0cf Binary files /dev/null and b/documentation/images/reload.png differ diff --git a/documentation/images/resinstall/boot.png b/documentation/images/resinstall/boot.png new file mode 100644 index 0000000..385a81f Binary files /dev/null and b/documentation/images/resinstall/boot.png differ diff --git a/documentation/images/resinstall/bootinstall.png b/documentation/images/resinstall/bootinstall.png new file mode 100644 index 0000000..d34eecc Binary files /dev/null and b/documentation/images/resinstall/bootinstall.png differ diff --git a/documentation/images/resinstall/configure.png b/documentation/images/resinstall/configure.png new file mode 100644 index 0000000..33bdcbb Binary files /dev/null and b/documentation/images/resinstall/configure.png differ diff --git a/documentation/images/resinstall/system.png b/documentation/images/resinstall/system.png new file mode 100644 index 0000000..41b57e4 Binary files /dev/null and b/documentation/images/resinstall/system.png differ diff --git a/documentation/images/save.png b/documentation/images/save.png new file mode 100644 index 0000000..071d54d Binary files /dev/null and b/documentation/images/save.png differ diff --git a/documentation/images/scale.png b/documentation/images/scale.png new file mode 100644 index 0000000..bf62e5c Binary files /dev/null and b/documentation/images/scale.png differ diff --git a/documentation/images/search.png b/documentation/images/search.png new file mode 100644 index 0000000..6744873 Binary files /dev/null and b/documentation/images/search.png differ diff --git a/documentation/images/security.png b/documentation/images/security.png new file mode 100644 index 0000000..1070999 Binary files /dev/null and b/documentation/images/security.png differ diff --git a/documentation/images/stop.png b/documentation/images/stop.png new file mode 100644 index 0000000..975333a Binary files /dev/null and b/documentation/images/stop.png differ diff --git a/documentation/images/themes.png b/documentation/images/themes.png new file mode 100644 index 0000000..27a8010 Binary files /dev/null and b/documentation/images/themes.png differ diff --git a/documentation/images/up.png b/documentation/images/up.png new file mode 100644 index 0000000..b773dad Binary files /dev/null and b/documentation/images/up.png differ diff --git a/documentation/index.en b/documentation/index.en new file mode 100644 index 0000000..b03dbcd --- /dev/null +++ b/documentation/index.en @@ -0,0 +1,209 @@ + + + +NetSurf | Documentation + + + + + + + + + +
+ + + +

Documentation

+ +

This page provides an overview of NetSurf's documentation. The documentation is split into sections, as follows:

+ + + +

Last updated 2 January 2007

+ +

General documentation

+ + + +

User documentation

+ + + +

Contributor documentation

+ + + +

Developer documentation

+ + + + + + +
+ + +
+ +
+ + + \ No newline at end of file diff --git a/documentation/info.en b/documentation/info.en new file mode 100644 index 0000000..1bd5376 --- /dev/null +++ b/documentation/info.en @@ -0,0 +1,140 @@ + + + +NetSurf | User Information + + + + + + + + + +
+ + + +

User Information

+ +

This page is is relevant to all users of NetSurf. RISC OS users can also check the RISC OS user information further information on the RISC OS version of NetSurf.

+ + + +

Last updated 2 January 2008

+ +

Getting NetSurf

+ +

There are two versions of NetSurf available:

+ +
+
Stable releases
+
These are recommended for most users, particularly if this is your first experience of NetSurf.
+
Development builds
+
These are built automatically from the latest bleeding-edge source code and may be unstable. Development builds are currently available only for RISC OS users. Users of other platforms can obtain the latest source code and follow the simple compilation instructions.
+
+ +

Note that some features may be fully implemented on the RISC OS version and not started on the GTK version. This is indicated on the progress page.

+ +

Which version to choose

+ +

If you are new to NetSurf (or don't want to run potentially unstable versions), the stable release series is the best option. Stable releases are made infrequently and comprise bug and security fixes to the previous stable release. Major stable releases introduce new features and form the base of the next stable release series.

+ +

If you want to keep up with the latest developments in NetSurf, then the development builds are for you. However, as these represent the current state of development, they may be unstable or introduce new bugs. They also have significantly less testing than releases from the stable series.

+ +

Reporting bugs

+

The NetSurf developers are very much open to bug reports. Please follow these simple guidelines.

+ +

Before submitting a bug report, please:

+ +
    +
  1. check that the bug exhibits itself in the latest version available for download at the time.
  2. +
  3. try to find a reproducible way of triggering the bug.
  4. +
  5. check the progress page be sure that something has actually been implemented.
  6. +
+ +

When reporting bugs, please:

+ +
    +
  1. state the version of NetSurf you are using.
  2. +
  3. say what hardware and operating system you are using.
  4. +
  5. say whether you can reproduce the problem or whether is was a one-off occurrence that you can't reproduce.
  6. +
  7. explain clearly and concisely the precise nature of the problem. (eg. does the computer hang, does NetSurf crash or report an error or is there a layout problem on a particular site? If it is a layout problem, please explain what is wrong.)
  8. +
  9. if a specific site is failing, give the full URL.
  10. +
  11. list the exact steps required to reproduce the bug.
  12. +
  13. if you can narrow a bug down to a minimal test-case, then that's great. Please provide it as it's likely to speed up a fix. (Don't worry if you can't.)
  14. +
+ +

Bug reports should be made on the bug tracker. Follow the "Submit New" link and fill in the form. If you have no SourceForge user account, please include your email address so that the developers can contact you. Note that when uploading files to the bug tracker (e.g. Log files), you may need to compress the file before uploading. The limit is 256kB.

+ +

Following the above guidelines will save the developers' time and speed up NetSurf's development.

+ +

Feature requests

+ +

The NetSurf team welcome feature requests and innovative ideas for improving the browsing experience. Before making suggestions, please look at the progress page to check that the feature isn't already planned. Suggestions can be made on the feature request tracker.

+ +

JavaScript

+ +

At present, NetSurf has no support for JavaScript. Without a JavaScript implementation, NetSurf is able to provide access to most of sites on the World Wide Web. Some sites, however, will not display correctly or be unworkable due to heavy reliance on this standard.

+ +

JavaScript is support is planned but we are currently a long way off supporting it. Many things need to be done before JavaScript can be considered, such as a DOM implementation. JavaScript support will require a huge amount of work to complete. If you are keen to help out please visit the developer and contributor area.

+ + + + +
+ + +
+ +
+ + + \ No newline at end of file diff --git a/documentation/nstheme.en b/documentation/nstheme.en new file mode 100644 index 0000000..bfc7e3c --- /dev/null +++ b/documentation/nstheme.en @@ -0,0 +1,156 @@ + + + +NetSurf | NSTheme Guide + + + + + + + + + +
+ + + +

Creating Themes

+ +

This document is a brief guide to creating themes for use with NetSurf and packaging them with NSTheme. It is split up into the following sections:

+ + + +

Last updated 22 March 2005

+ +

Overview

+ +

A theme contains a set of sprites for NetSurf's toolbar icons and some further information about the theme, such as the background colour of the toolbar and the theme name. NSTheme is an application that loads the sprites, allows the additional information to be set and then packages the theme into a single file for distribution.

+ +

Sprites

+ +

A theme contains a number of sprites; two for each button, a single separator sprite and extra sprites for the throbber animation. These sprites are to be grouped into a single sprite file and each sprite must be given a certain name, so that they can be attributed to the correct button.

+ +

The toolbar buttons and the matching sprite names are listed below.

+ + + + + + + + + + + + + + + + +
Browser Window
ButtonSprite name
Backback
Forwardforward
Historyhistory
Homehome
Hotlisthotlist
Printprint
Reloadreload
Savesave
Scale Viewscale
Search / Find Textsearch
Stopstop
Upup
+ + + + + + + + + +
Hotlist Window
ButtonSprite name
Create Directorycreate
Delete Selectiondelete
Launch Selectionlaunch
Open Directoryopen
Expand Addressesexpand
+ + + + + + + + +
Global History Window
ButtonSprite name
Delete Selectiondelete
Launch Selectionlaunch
Open Directoryopen
Expand Addressesexpand
+ +

Each button has a sprite for its pressed and unpressed states. The pressed sprites are preceded with the letter 'p'. For the Save button, there will be both 'save' and 'psave' sprites.

+ +

A sprite named 'separator' is used to separate groups of icons on the toolbar and the throbber is made up of any number of sprites named 'throbber0' to 'throbberN'. When NetSurf is inactive, 'throbber0' is displayed and when it is active, the throbber animation loops through 'throbber1' to 'throbberN'.

+ +

For a five frame animation, there would be five sprites named 'throbber1' to 'throbber5' plus the inactive sprite, 'throbber0'.

+ +

The sprites can have any dimensions and if some sprites are larger than others, NetSurf will centre the smaller ones on the toolbar automatically.

+ +

Using NSTheme

+ +

NSTheme's user interface should be fairly self explanatory and interactive help is available throughout the application. An existing theme can be loaded by dragging it to the NSTheme window. To create a new theme, drag a sprite file to NSTheme. Theme name and author information can be entered or altered with writable icons.

+ +

Tick "Left align throbber" if you want the throbber to appear at the left of the toolbar. If un-ticked, the throbber will be displayed at the right. If your throbber animation uses a mask that moves from frame to frame, tick "Redraw every frame", which clears the previous frame of amimation before plotting the new one on top. Leave "Redraw every frame" un-ticked if the throbber doesn't feature a moving mask as this feature can make the throbber flicker while it animates.

+ +

The Generate report button warns of any problems with the theme. For example, if no sprites have been loaded it will report, "No sprite file present". If a sprite file is loaded but the pressed Save button is missing, it will report, "Sprite 'psave' (browser save icon (pushed)) is missing". The Remove sprites button removes any sprites that had been loaded into the program.

+ +

Sprites can be extracted from an existing theme with the Export option on the NSTheme window menu. When creating a new theme it may be helpful to extract the sprite file from the supplied theme (!NetSurf.Resources.Theme) and replace these sprites with your own.

+ +

In the colours section, the background colours for the browser window toolbar, the hotlist toolbar and the browser window's status bar can be configured, along with the colour of text displayed in the status bar.

+ +

To save a finished theme, use the save option in the NSTheme window menu. Once a theme file has been created, it must be placed in Choices:WWW.NetSurf.Themes to be found by NetSurf.

+ +

Distribution

+ +

Completed themes can be submitted for inclusion on NetSurf's themes page. They are served as Content-Type: application/x-netsurf-theme which NetSurf recognizes and installs as themes.

+ + + + +
+ + +
+ +
+ + + \ No newline at end of file diff --git a/documentation/progress.en b/documentation/progress.en new file mode 100644 index 0000000..34398ea --- /dev/null +++ b/documentation/progress.en @@ -0,0 +1,300 @@ + + + +NetSurf | Development Progress + + + + + + + + + +
+ + + +

Development Progress

+ +

This page provides an indication of the current status of various features and gives an idea of where future development will be aimed. Features are split up as follows:

+ + + +

Last updated 30 April 2009

+ +

+ + + + + + + +
TitleStatusNotes
Web standardsIn progressMost of HTML 4 and CSS 2.1 are implemented which enabled NetSurf to access most of the web, however, JavaScript is currently unimplemented. This means NetSurf currently lacks support for certain dynamic content.
User interface (RISC OS)Nearly doneRISC OS interface is mature.
User interface (GTK)In progressThe nsgtk user interface is sufficient to allow web browsing but currently lacks many features expected of a web browser.
DocumentationIn progressMuch of the core functionality and RISC OS specific features are documented. There is very scant documentation for nsgtk.
+ +

Web standards

+ + + + + + + + + + + + + + + + + +
TitleStatusNotes
CookiesNearly doneUser interface to handle invalid cookies not available.
CSS 1Nearly done
CSS 2Nearly done
CSS 3Just startedSome of the selectors have been implemented.
HTML 4Nearly done
HTML 5Just startedAn HTML 5 compliant parser is being developed.
HTTP 1.1Complete
HTTP AuthenticationComplete
HTTPSComplete
DOM Level 0Just startedCore mostly complete.
DOM Level 1Just startedCore mostly complete.
DOM Level 2Just startedCore mostly complete.
DOM Level 3Just startedCore mostly complete.
JavaScriptNot startedDetails on the User Information page.
+ +

Important HTML features

+ + + + + + + + +
TitleStatusNotes
FormsNearly done
FramesNearly doneMargin attributes are unimplemented.
Frames affect back / forward navigation and history thumbnails.
Image MapsComplete
ListsComplete
TablesNearly doneElements col, colgroup, rowgroup and caption not implemented.
Extra space is divided equally among columns instead of in proportion with content width.
+ +

CSS features

+ + + + + + + + + +
TitleStatusNotes
SelectorsNearly doneCSS 1 and CSS 2 selectors implemented. A few CSS 3 selectors are implemented too.
Pseudo-classesJust started
Pseudo-elementsJust started
Media typesNearly doneNetSurf currently only uses the screen-targetted CSS, even when printing.
@importComplete
CascadeNearly doneThere is no user stylesheet.
+ +

CSS properties

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TitleStatusNotes
background-attachmentNot started
background-colorComplete
background-imageComplete
background-positionComplete
background-repeatComplete
background (shorthand)Complete
border-collapseComplete
border-colorComplete
border-spacingComplete
border-styleComplete
border-[top|right|bottom|left]Complete
border-*-colorComplete
border-*-styleComplete
border-*-widthComplete
bottomComplete
caption-sideNot started
clearNearly doneSome issues with floats remain.
clipNot started
colorComplete
contentNot started
counter-incrementCompleteCan't be used until content property is implemented.
counter-resetCompleteCan't be used until content property is implemented.
cursorComplete
directionNot started
displayComplete
empty-cellsNot started
floatNearly doneSome issues with floats remain.
font-familyNearly doneOnly generic font types are recognised, not specific font names.
font-sizeComplete
font-size-adjustNot started
font-stretchNot started
font-styleComplete
font-variantIn progressSmall caps not done.
font-weightComplete
font (shorthand)CompleteDependent on the status of individual properties.
heightComplete
leftComplete
letter-spacingNot started
line-heightNearly done
list-style-imageComplete
list-style-positionNot started
list-style-typeNearly done
list-style (shorthand)CompleteDependent on the status of individual properties.
margin-[top|right|bottom|left]Complete
margin (shorthand)Complete
marker-offsetNot started
marksNot started
max-heightComplete
max-widthComplete
min-heightComplete
min-widthComplete
orphansNot started
outline-colorNot started
outline-styleNot started
outline-widthNot started
outline (shorthand)Not started
overflowComplete
padding-[top|right|bottom|left]Complete
padding (shorthand)Complete
pageNot started
page-break-[after|before|inside]Not started
positionIn progressFixed position not implemented.
quotesNot started
rightComplete
sizeNot started
table-layoutNot started
text-alignComplete
text-decorationComplete
text-indentComplete
text-shadowNot started
text-transformComplete
topComplete
unicode-bidiNot started
vertical-alignIn progressOnly implemented for table cells.
visibilityIn progress
white-spaceIn progress
widowsNot started
widthComplete
word-spacingNot started
z-indexNot started
+ +

Image support

+ + + + + + + + + + + + + + + +
TitleStatusNotes
Artworks (RISC OS)CompleteRequires AWRender.
BMPComplete
Drawfile (RISC OS)Complete
GIFComplete
ICOComplete
JNGComplete
JPEGComplete
MNGNearly doneInteractive features aren't supported.
PNGNearly doneGamma correction is not correct for PNGs with alpha channels.
Sprite (RISC OS)Complete
SVG Tiny (RISC OS)In progressVia Libsvgtiny.
SVG (GTK)CompleteVia rsvg.
+ +

RISC OS specific standards

+ + + + + + +
TitleStatusNotes
Acorn URI ProtocolComplete
Ant URL ProtocolComplete
Plugin ProtocolNearly doneIncomplete implementation.
+ +

NetSurf features

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TitleStatusNotes
Advertisement BlockingComplete
Buffered Rendering OptionsCompleteSubstantially improves the display of content.
Details in the User Guide (RISC OS).
Configuration (RISC OS)Complete
Configuration (GTK)Nearly done
Disc CacheNot started
Dithering (RISC OS)CompleteGives improved rendering in sub true colour screen modes.
Both simple dithering and error diffusion available.
Documentation (RISC OS)Nearly doneSee the contents page.
Documentation (GTK)Just startedCurrently only build instructions exist for nsgtk. There is no user guide.
Downloads (RISC OS)CompleteFollowing a link to a file NetSurf can't render opens the download dialogue box.
Downloads (GTK)Complete
Find Text (RISC OS)Nearly doneDoesn't find phrases if they are split across lines.
Find Text (GTK)Just started
Full Save (RISC OS)Nearly doneSave pages with CSS files and images.
Doesn't rewrite URLs for CSS background images.
Full Save (GTK)Not started
History - Global (RISC OS)Nearly doneDetails in the User Guide.
History - Global (GTK)Just startedSome support but very incomplete.
History - Local (RISC OS)CompleteDetails in the User Guide.
History - Local (GTK)Nearly done
Hotlist / bookmarks (RISC OS)Nearly doneDetails in the User Guide.
Hotlist / bookmarks (GTK)Not started
Interactive Help (RISC OS)Nearly done
Interactive Help (GTK)Nearly doneExtensive tool tips for GUI but none for rendering area.
Memory CacheComplete
Printing (RISC OS)CompleteDetails on the RISC OS User Information page.
Printing (GTK)Complete
Proxy SupportIn progressProtocols other than HTTP are incorrectly proxied.
Save as Drawfile (RISC OS)Nearly doneEmbedded drawfiles aren't exported when saving page as Draw. (Draw is a RISC OS vector graphics format.)
Save as Text (RISC OS)In progressSome issues with spacing out of text.
Save as Text (GTK)Not started
Scale View (RISC OS)CompleteWeb pages and images can be scaled up and down.
Text SelectionNearly doneText selection in text areas is incomplete.
Themes (RISC OS)CompleteThemes are available from the NetSurf themes page.
Themes (GTK)In progress
Toolbar Customisation (RISC OS)CompleteToolbars can be customised to show the icons you want, in the order you want.
Details in the User Guide.
Toolbar Customisation (GTK)Not started
Unicode Font Support (RISC OS)Nearly doneDetails on the RISC OS User Information page.
Unicode Font Support (GTK)Complete
URL CompletionCompleteWhen typing a URL into the URL bar, NetSurf will display suggestions for the full address.
View Source (RISC OS)CompletePress F8 or Page > View source on main menu.
View Source (GTK)Complete
+ + + + +
+ + +
+ +
+ + + \ No newline at end of file diff --git a/documentation/resinstall.en b/documentation/resinstall.en new file mode 100644 index 0000000..c3a0c34 --- /dev/null +++ b/documentation/resinstall.en @@ -0,0 +1,129 @@ + + + +NetSurf | RISC OS Resource Installation Guide + + + + + + + + + +
+ + + +

RISC OS Resource Installation Guide

+ +

This page is a pictorial guide to installing resources on RISC OS.

+ + + +

Last updated 29 November 2008

+ +

Introduction

+ +

Many RISC OS applications depend on some shared resources and modules in order to run. These shared resources can be used by several different programs at the same time and are stored inside the RISC OS Boot Structure.

+ +

NetSurf, like many RISC OS applications, comes with two directories; !Boot and !System. These directories contain all the resources that NetSurf requires to run. The Boot Structure is specifically organised so that applications can find the resources they need to run.

+ +

To install the resources that NetSurf depends on, the supplied !Boot and !System directories need to be merged with your system's Boot Structure. Fortunately this procedure is automated by drag-and-drop tools which do this job for you.

+ +

Running Configure

+ +

First of all, we need to run the RISC OS Configure application. There are several ways to do this:

+ + + +

The Configure Window

+ +

After running Configure you will have a window which looks like the above. Note that the icons you see will vary depending on which version of RISC OS you have.

+ +

Merging a !System directory

+ +

In the Configure window, click on the "System" icon. This opens the System Merge window, as pictured below.

+ +

The System Merge Window

+ +

Simply drag the !System directory supplied with the software onto this window and click the "Merge" button. The System Merge tool will then automatically merge the new resources into your Boot Structure.

+ +

Merging a !Boot directory

+ +

In the Configure window, click on the "Boot" icon. This opens the Boot sequence Configure window, as pictured below.

+ +

The Boot sequence Configure Window

+ +

In this window, click on the "Install" icon. This opens the Boot Merge window, as pictured below.

+ +

The Boot Merge Window

+ +

Simply drag the !Boot directory supplied with the software onto this window and click the "Merge" button. The Boot Merge tool will then automatically merge the new resources into your Boot Structure.

+ +

Note: some old versions of RISC OS do not have a Boot Merge tool. In this case, you must instead drop the supplied !Boot over the !Boot directory which resides in the root directory of your hard disc drive.

+ + + + + +
+ + +
+ +
+ + + \ No newline at end of file diff --git a/documentation/robuild.en b/documentation/robuild.en new file mode 100644 index 0000000..31a878e --- /dev/null +++ b/documentation/robuild.en @@ -0,0 +1,107 @@ + + + +NetSurf | Building on RISC OS + + + + + + + + + +
+ + + +

Building NetSurf on RISC OS

+ +

This document outlines the process required to get a build system for NetSurf set up on a RISC OS machine.

+ + + +

Last updated 10 August 2009

+ +

Requirements

+ + + +

Getting started

+ +

This section details quick-start instructions for getting NetSurf compiled under RISC OS. If you want more detail, see the rest of this document.

+ +
    +
  1. Download and install the requirements listed above.
  2. +
  3. Force the RISC OS SVN client to handle ,xxx extensions correctly by issuing: +
    *Set svn$filetypeext ""
    +This may be set permanently by uncommenting the appropriate line in !SVN's !Boot file.
  4. +
  5. Check out the latest source code from SVN, by issuing the following command in a TaskWindow: +
    *svn co svn://svn.netsurf-browser.org/trunk/netsurf
  6. +
  7. Open the "netsurf" directory that gets created, this now contains all the source code.
  8. +
  9. Read the "BUILDING-RISC_OS" document in the "Docs" directory. This explains how to actually get NetSurf to build.
  10. +
+ + + +
+ + +
+ +
+ + + diff --git a/documentation/roinfo.en b/documentation/roinfo.en new file mode 100644 index 0000000..3bb00c2 --- /dev/null +++ b/documentation/roinfo.en @@ -0,0 +1,186 @@ + + + +NetSurf | RISC OS User Information + + + + + + + + + +
+ + + +

RISC OS User Information

+ +

This page is for issues specific to the RISC OS version of NetSurf. See the general user information page for more information about NetSurf.

+ + + +

Last updated 23 December 2011

+ +

Getting started

+ +

Installation

+ +

NetSurf requires RISC OS 4.02 or later and builds are available from the project's web site.

+ +

Installation of "NetSurf" is a three step process:

+ +
    +
  1. Use the Boot Merge facility provided by Configure to merge the supplied !Boot directory with the one on your system.
    If there is no !Boot merge facility on your system, simply drag the supplied !Boot over your existing boot structure.
  2. +
  3. Use the System Merge facility provided by Configure to merge the supplied !System directory with the one on your system.
  4. +
  5. Drag the !NetSurf application directory out of the archive, to your desired location.
  6. +
+ +

Double click on !NetSurf in your chosen location to launch NetSurf.

+ +

Note: if you are unsure how to follow steps 1 and 2 above, then please see our pictorial guide to resource installation.

+ +

Requirements

+ +

When NetSurf is run it will look for all the resources it needs to function correctly. If anything is not found, it displays an error message indicating the resource it could not locate on your system. If such a message appears, NetSurf is likely to be requesting one of the following resources.

+ +

Items contained in the !Boot and !System directories supplied with NetSurf:

+ +
+
Acorn URI
+
The Acorn URI module is used to pass URIs (of which URLs are an example) back and forth between different applications.
+
Iconv
+
This module provides improved character encoding support.
+
SharedUnixLibrary
+
This is a support module for programs compiled using UnixLib.
+
Tinct
+
Tinct is used for image plotting. It provides support for plotting sprites with alpha channels.
+
+ +

If NetSurf starts without a problem, there is no need to upgrade any resources on your system.

+ +

Additional Resources

+ +

The following resources are not required to run NetSurf, although they do add additional functionality.

+ +
+
Flash plugin
+
This allows you to view Flash files on web sites.
+
MimeMap Datafile
+
A resource containing many different MIME types and their equivalent RISC OS file types.
+
+ +

Upgrading NetSurf

+ +

If you are upgrading from a previous version of NetSurf, quit NetSurf and delete your old version. Drag the !NetSurf application to your required destination. NetSurf stores your choices, cookies, hotlist and themes in Choices:WWW.NetSurf, so the !NetSurf application directory can be deleted without any loss of your NetSurf configuration.

+ +

It is possible to copy the new version of NetSurf over your old version to perform the upgrade. Please be aware that this could result in files that are no longer required being left in your copy of NetSurf although this should not cause any problems in usage.

+ +

Fonts in NetSurf

+ +

NetSurf has support for displaying pages containing Unicode characters that aren't normally available on RISC OS, for example accented Latin letters, Greek, Cyrillic, Japanese, and various symbols.

+ +

The font choices let you pick a font for each of the five standard families available to web authors (in CSS). The choices specify the preferred font to use. If a character is not available in the chosen font, but it's present in some other font that you have installed, then NetSurf will automatically use it. There's no need to change the font choices to view pages with characters that are not available in the chosen font.

+ +

Note that you can only choose a font family. NetSurf will automatically use weights from the family for bold and slanted text, if available.

+ +

Installing More Fonts

+ +

The fonts that come with RISC OS cover Latin (Homerton, Trinity, Corpus), Greek (Sidney), and various symbols (Selwyn, Sidney). (On RISC OS 3-4, only the "Latin 1" characters from the standard fonts, which cover Western European languages, can be used by NetSurf).

+ +

If you want to display pages with other characters correctly, you'll need to install fonts containing them. When a character is not present in any available font, the Unicode character code will be displayed.

+ +

If you see the codes 0091, 0092, 0096, or others starting 009, that indicates that the page is not specifying the character set that it is using correctly. Installing fonts won't help. We haven't yet decided what the best way to work around this problem is.

+ +

Any font supplied with a correctly designed "Encoding" file should work. In practice, native fonts covering anything other than Latin 1 are rare. The solution is to convert TrueType fonts using TTF2f (this currently produces fonts suitable for RISC OS 5 only).

+ +

After installing new fonts, NetSurf will need restarting so that it detects them.

+ +

Problems and Unimplemented Features

+ + + +

Printing

+ +

When NetSurf is run without the Unicode Font Manager, printing will work correctly. When printing with the Unicode Font Manager, as on RISC OS 5 or with a softloaded Unicode Font Manager, there are a few things you may need to install.

+ +
    +
  1. Using the standard RISC OS 5 release of the printer drivers doesn't work due to lack of Unicode support in the RISC OS 5 printer drivers. However, a version of "Printers" that supports printing to non-PostScript printers is available from RISC OS Open Ltd.
  2. +
  3. Printing to PostScript printers with Unicode support is not possible with the standard PostScript drivers. In order to print correctly, the more advanced PostScript 3 printer driver by John Tytgat and Martin Würthner is required.
  4. +
  5. If you use Geminus, you'll need to run at least version 1.34.
  6. +
+ + + + +
+ + +
+ +
+ + + diff --git a/documentation/translations.en b/documentation/translations.en new file mode 100644 index 0000000..f86ab84 --- /dev/null +++ b/documentation/translations.en @@ -0,0 +1,136 @@ + + + +NetSurf | Producing Translations + + + + + + + + + +
+ + + +

Producing Translations

+ +

This page contains information for anyone interested in translating NetSurf into other languages.

+ + + +

Last updated 17 June 2006

+ +

Getting started

+ +

Translations of NetSurf into other languages are very welcome. Currently we have the reference version in English and translations into Dutch, French and German.

+ +

Mailing list

+ +

Translators are encouraged to join the developer's mailing list. Please join the mailing list if you would like to translate NetSurf into a new language or help with an existing translation.

+ +

The mailing list is for any discussion related to development or translation of NetSurf and will be used to indicate any changes that have been made to NetSurf's interface, web site or documentation.

+ +

Obtaining files

+ +

There are two types of files that can be translated; those that are part of the web site and those that are part of the NetSurf application.

+ +

The documentation is part of the web site and it is copied into the NetSurf application by the autobuilder. The autobuilder automatically makes a few changes to links in the documentation, to ensure they work off line. It is important that it is the web site version of the documentation is translated.

+ +

The simplest way to get the latest files is to use Subversion, as follows:

+ +

*svn checkout svn://svn.netsurf-browser.org/trunk/netsurf/!NetSurf
*svn checkout svn://svn.netsurf-browser.org/trunk/netsurfweb

+ +

The Subversion client must first have been seen by the filer.

+ +

The important files are

+ + + +

"??" is a two letter country code, such as "de" (Germany) or "fr" (France)

+ +

Alternatively, the three files from !NetSurf can be taken from the latest build and any documentation or web material can be found on the web site. Do not be put off by the amount of files that can be translated. A translation of just NetSurf's interface is much better than no translation at all!

+ +

Please translate from the English version as this will always be most up to date.

+ +

Requirements

+ +

No programming knowledge is required, just the ability to use a template editor (for example WinEd) and a text editor capable of editing UTF-8 encoded files (for example Zap).

+ +

NetSurf's Messages files are UTF-8 encoded. In Zap 1.47 Beta, to select UTF-8 mode, click menu over the window and select:

+ +

Edit > Encoding > UTF8

+ +

File submission

+ +

Please send any translated files to Michael <tlsa@netsurf-browser.org>.

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