source: branches/tree/HELP_SOURCE/source/help.hlp

Last change on this file was 18769, checked in by westram, 3 years ago
  • move all helpfiles to new source location
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 4.6 KB
Line 
1#Please insert up references in the next lines (line starts with keyword UP)
2UP      arb.hlp
3
4#Please insert subtopic references  (line starts with keyword SUB)
5#SUB    subtopic.hlp
6
7# Hypertext links in helptext can be added like this: LINK{ref.hlp|http://add|bla@domain}
8
9#************* Title of helpfile !! and start of real helpfile ********
10TITLE           Using embedded help
11
12DESCRIPTION
13
14        There are several versions of ARB help:
15
16              - an embedded, context-sensitive version (press any 'HELP' button inside ARB)
17              - an HTML version which is located in $ARBHOME/lib/help_html
18                - it may be started using the BROWSE button in embedded help windows
19                - If arb is installed in /usr/arb it may be accessible at LINK{file:///usr/arb/lib/help_html/arb.html}.
20              - This HTML help is also available via LINK{http://help.arb-home.de/arb.html}.
21                Please note that the online version may be more recent than your ARB version!
22
23    The following is about the embedded help module:
24
25        The embedded help is available by clicking on the 'HELP' menu
26        (flat) or buttons (raised) located in most windows.
27
28                Clicking on a <HELP> button displays the 'HELP
29                WINDOW' with help for that window.
30
31                Clicking on the 'HELP' menu and choosing 'Click here
32                and then on the questionable button/menu/...' switches
33                to the context-sensitive help mode (indicated by the
34                'open question cursor'). Then click on any button or
35                prompt to display the 'HELP WINDOW' showing help for
36                the pressed button/menu/...
37
38        There are two formats of embedded 'HELP' texts:
39
40                Normally, ARB uses simple ASCII texts displayed within the
41                'HELP WINDOWS'.
42
43                        The titles of help texts on related main- and subtopics
44                        linked to the current help file are displayed in the
45                        subwindows in the lower part of the 'HELP WINDOW' and
46                        are activated by clicking on the tile prompts.
47
48                        Press the <BACK> button in the upper part of the 'HELP
49                                WINDOW' to display the former help text.
50
51                Some 'HELP' texts are stored as postscript files and displayed
52                using the public domain software 'ghostview'.
53
54                                Press <Ghostview/Page/Next> to display the following
55                                page(s), <Ghostview/File/Print> to print the
56                                help text. <Ghostview/File/Quit> to leave
57                                ghostview.
58
59        Format:
60
61                "text" indicates an important term.
62
63                'text' indicates ARB-specific terms, paths, tools and prompts.
64
65                <text> indicates buttons.
66
67        Terminology:
68
69          Screen:
70
71                "Windows" are the workstation work areas. The names are
72                        displayed at the very top of the window.
73
74                "Subwindows" (indented) are display and input areas within
75                        windows.
76
77                "Menu bars" at the top of windows (if present) are used to
78                        expose menu choices. The menus are displayed after
79                        clicking on the prompts of the menu bar.
80
81                "Menu buttons" are raised rectangular buttons containing a small
82                        raised rectangle at the right. Menu options are exposed
83                        after clicking on the button.
84
85                "Menus" initiate actions after clicking on the items.
86
87                "Scroll bars" at the extreme right and bottom of windows and
88                        subwindows allow to move through the display area in
89                        various increments.
90
91          Mouse buttons communicate commands to the program:
92
93                "Left mouse button" is used for clicking on prompts, checkboxes and buttons.
94                      and to select and modify the main display area.
95
96                "Middle and right mouse buttons" are used for modifying the main display
97                        (see LINK{mode.hlp})
98
99                "Mouse-Wheel" is used to scroll the a display-area (vertically or horizontally
100                              when used with ALT/META) or to zoom the display (when used with CTRL).
101
102                "Press" means hold down the mouse button while completing an
103                        operation.
104
105                "Release" means to let go of the mouse button.
106
107                "Click on" means positioning the cursor on a location, prompt,
108                        button or checkbox, pressing and immediately releasing
109                        the mouse button.
110
111                "Choose" from a menu means clicking on the desired menu option.
112
113
114NOTES           The 'HELP' texts for foreign programs or tools which have been
115                incorporated into ARB (see LINK{arb.hlp}) are usually (parts of)
116                the original documentation or help texts.
117
118                The ASCII texts can be edited by clicking on the <EDIT> button
119                of the 'HELP WINDOW' and can be modified by the user. Write
120                permission is needed for '$ARBHOME/lib/help'. (This only works
121                if you build arb from source)
122
123                See LINK{props_www.hlp} on how to configure the BROWSE button.
124
125BUGS            In the current release, the 'open question pointer' is reset to
126                the original symbol when moved to a menu item.
Note: See TracBrowser for help on using the repository browser.