mirrors
/
netsurf
mirror of https://github.com/netsurf-browser/netsurf
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added more pages to AmigaGuide doc

This commit is contained in:
Chris Young 2013-01-24 20:01:27 +00:00
parent 18091ec1a9
commit f058e98817
1 changed files with 98 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

106
amiga/dist/NetSurf.guide vendored
View File

@ -7,14 +7,18 @@
http://www.netsurf-browser.org
@{" Change Log " link ChangeLog/Main}
@{" Licence " link COPYING/Main}
@{" GUI " link GUI}
@{" Preferences GUI " link Prefs}
@{" Command line options " link CLI}
@{" Options file " link Options}
@{" Fonts " link Fonts}
@{" ARexx port " link ARexx}
@{" OpenURL/URL Prefs " link OpenURL}
@{" Hotlist menu " link Hotlist}
@{" Hotlist toolbar " link HotlistToolbar}
@{" Local MIME types " link MIMETypes}
@{" Keyboard controls " link Keyboard}
@ -23,6 +27,81 @@ http://www.netsurf-browser.org
@{" Credits " link Contact}
@endnode
@node GUI "Main window"
NetSurf's main GUI consists of a toolbar across the top, an (optional) tab bar, an (optional) hotlist toolbar and the main browser area. It also encompasses a pull-down @{"menu" link Menu}.
The toolbar buttons are, from left to right:
@{b}Back@{ub} Go back one page in history. Right-clicking gives a menu showing the last ten pages visited.
@{b}Forward@{ub} Go forward one page in history. Right-clicking gives a menu showing up to ten pages available.
@{b}Stop@{ub} Stop loading the page.
@{b}Reload@{ub} Reload the current page. Shift-clicking will reload all elements on the page.
@{b}Home@{ub} Load the home page.
The gadget to the right of the buttons is the URL bar to type web addresses into. On the far right is the search bar. Typing into here will search for the text using your default search provider (see preferences @{"Advanced tab" link Prefs-Advanced}.
Below these is the (optional) @{"hotlist toolbar" link HotlistToolbar}.
Below this is the (optional) tab bar. This usually only displays when more than one tab is open, but can be set in @{"preferences" link Prefs-Tabs} to be always present. At the far right is a button to open a new tab. On OS4.0 the current tab can be closed using the button on the far left. On OS4.1 the close gadget for the tab is embedded in the tab itself.
The rest of the window is taken up with the @{"browser rendering area" link Browser}. This is where the pages visited will be displayed.
@endnode
@node Browser
@toc GUI
This is the main browser rendering area.
Drag and drop is supported throughout, so files can be dropped onto text fields, text on pages can be highlighted and dragged to Workbench or text fields. Other elements can be saved by dragging them to Workbench with Ctrl or Shift held down.
Note that dragging to Workbench only works when NetSurf is running on the Workbench screen.
@endnode
@node Menu "Menu"
@toc GUI
Project Browser Edit @{"Hotlist" link Hotlist} @{"ARexx" link arexx}
@endnode
@node Prefs "Preferences GUI"
@{"General" link Prefs-General} @{"Display" link Prefs-Display} @{"Connection" link Prefs-Connection} @{"Rendering" link Prefs-Rendering} @{"Fonts" link Prefs-Fonts} @{"Cache" link Prefs-Cache} @{"Tabs" link Prefs-Tabs} @{"Advanced" link Prefs-Advanced} @{"Export" link Prefs-Export}
@endnode
@node Prefs-General "Prefs - General"
@toc Prefs
@endnode
@node Prefs-Display "Prefs - Display"
@toc Prefs
@endnode
@node Prefs-Connection "Prefs - Connection"
@toc Prefs
@endnode
@node Prefs-Rendering "Prefs - Rendering"
@toc Prefs
@endnode
@node Prefs-Fonts "Prefs - Fonts"
@toc Prefs
See @{"Fonts" link Fonts}
@endnode
@node Prefs-Cache "Prefs - Cache"
@toc Prefs
@endnode
@node Prefs-Tabs "Prefs - Tabs"
@toc Prefs
@endnode
@node Prefs-Advanced "Prefs - Advanced"
@toc Prefs
@endnode
@node Prefs-Export "Prefs - Export"
@toc Prefs
This section contains options for exporting to PDF. It is not enabled in current builds of NetSurf.
@endnode
@node cli "Command line options"
NetSurf URL/K,FORCE/S
@ -44,13 +123,10 @@ There are a couple of Amiga-specific options which can only be changed directly
@{b}drag_save_icons@{ub} Enables displaying Workbench-style transparent icons under the pointer when performing drag saves (ctrl-drag of objects available if NetSurf is running on the Workbench screen) and text selection drags. If set to 0 the pointer style will change instead. OS 4.0 users may want to set this to 0 as icons will appear opaque and obscure the drop position.
@{b}cairo_renderer@{ub} Set rendering engine. -1 = palette-mapped (set automatically when required), 0 = graphics.library (default), 1 = Cairo/graphics.library mixed, 2 = Full Cairo.
@{b}monitor_aspect_x@{ub}/@{b}monitor_aspect_y@{ub} Correct aspect ratio for displays (default of 0 means "assume square pixels").
@{b}screen_compositing@{ub} Use compositing on NetSurf's own screen. 0=disable, 1=enable, 2=default
@{b}screen_compositing@{ub} Use compositing on NetSurf's own screen. 0=disable, 1=enable, 2=default (NB: This is indirectly modified by changing the "simple refresh" option in the GUI)
@{b}redraw_tile_size_x@{ub}/@{b}redraw_tile_size_y@{ub} Specify the size of the off-screen bitmap. Higher will speed up redraws at the expense of memory. 0 disables tiling (will use a bitmap at least the size of the screen NetSurf is running on)
@{b}font_antialiasing@{ub} Switch text anti-aliasing on or off. Defaults to on in true-colour modes, but text rendering performance can be improved by setting to 0.
@{b}window_simple_refresh@{ub} If set to 1, NetSurf will use SimpleRefresh rather than SmartRefresh windows. These have slower redraw but use less memory. Note that this setting has no noticeable effect if compositing is enabled. Defaults to 0 (SmartRefresh)
@{b}web_search_width@{ub} Defaults to 0. Larger values will increase the size of the web search gadget next to the URL bar.
@{b}dithering_quality@{ub} Specify the dithering quality from all values supported by picture.datatype. Currently these are 0=None, 1=Normal, 2=High quality. Other values are undefined. This is only used when NetSurf is running in palette-mapped mode.
@{b}mask_alpha@{ub} Threshold to use when determining which alpha values to convert to full transparency (0 - 255, where 255 will convert even opaque pixels to transparent). Defaults to 50 (0x32). This is only used in palette-mapped modes where alpha blending is not currently supported.
@{b}url_file@{ub} Path to URL database file
@ -61,7 +137,7 @@ There are a couple of Amiga-specific options which can only be changed directly
@endnode
@node Fonts
The font to use for each font type can be defined in NetSurf's options. OS4 NetSurf supports soft styles for bold and italic, however designed fonts look better and it is highly recommend to set them as follows:
The font to use for each font type can be defined in NetSurf's options. OS4 NetSurf supports soft styles for bold and italic, however designed fonts look better and it is highly recommended to set them as follows:
Within @{"TypeManager" system "SYS:System/TypeManager"} select a font being used by NetSurf and click on Modify.
On the Files tab, Font family section, choose the @{b}bold@{ub}, @{i}italic@{ui} and @{b}@{i}bold-italic@{ui}@{ub} version of the font.
@ -194,7 +270,7 @@ Folders with no items in them will show up disabled in the menu. If they are na
eg.
- Menu
- Hotlist Menu
|
+- Netsurf
| |
@ -216,6 +292,20 @@ Will look something like the following within the menu:
@endnode
@node HotlistToolbar "Hotlist toolbar"
A toolbar for frequently-accessed sites can be added to the main window. To do show, follow these steps:
* Select Show Hotlist from the Hotlist menu
The Hotlist window will be displayed.
* Locate the "Hotlist toolbar" folder in the tree (NetSurf creates this when it starts up)
* Move or create entries in this folder. Any entries directly inside the Hotlist toolbar folder will appear on the toolbar when the hotlist window is closed. If it is empty the toolbar will disappear to save space.
Note that sub-folders are not currently supported on the toolbar.
@endnode
@node mimetypes "Local MIME Types"
NetSurf determines the MIME types of local files primarily by checking the icon of the file. If the icon is not found it will check the default icon for the file type.
@ -294,5 +384,5 @@ The default theme icon was adapted from the NetSurf logo by Marko K. Sepp
All other code and files are the same for all platforms and credited in the files and/or on the NetSurf website.
http://www.netsurf-browser.org
The source code can be obtained from http://www.netsurf-browser.org SVN or (in the event the service is unavailable) chris@unsatisfactorysoftware.co.uk or any other of the NetSurf developers.
The source code can be obtained from http://source.netsurf-browser.org or (in the event the service is unavailable) chris@unsatisfactorysoftware.co.uk or any other of the NetSurf developers.
@endnode