← Back to branch summary

~statik/ubuntu/maverick/erlang/erlang-merge-testing

« back to all changes in this revision

Viewing changes to lib/toolbar/doc/src/toolbar_chapter.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sergei Golovan
  • Date: 2009-05-01 10:14:38 UTC
  • mfrom: (3.1.4 sid)
  • Revision ID: james.westby@ubuntu.com-20090501101438-6qlr6rsdxgyzrg2z
Tags: 1:13.b-dfsg-2
* Cleaned up patches: removed unneeded patch which helped to support
  different SCTP library versions, made sure that changes for m68k
  architecture applied only when building on this architecture.
* Removed duplicated information from binary packages descriptions.
* Don't require libsctp-dev build-dependency on solaris-i386 architecture
  which allows to build Erlang on Nexenta (thanks to Tim Spriggs for
  the suggestion).

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/toolbar/doc/src/toolbar_chapter.xml
 
1
<?xml version="1.0" encoding="latin1" ?>
 
2
<!DOCTYPE chapter SYSTEM "chapter.dtd">
 
3
 
 
4
<chapter>
 
5
  <header>
 
6
    <copyright>
 
7
      <year>1996</year>
 
8
      <year>2007</year>
 
9
      <holder>Ericsson AB, All Rights Reserved</holder>
 
10
    </copyright>
 
11
    <legalnotice>
 
12
  The contents of this file are subject to the Erlang Public License,
 
13
  Version 1.1, (the "License"); you may not use this file except in
 
14
  compliance with the License. You should have received a copy of the
 
15
  Erlang Public License along with this software. If not, it can be
 
16
  retrieved online at http://www.erlang.org/.
 
17
 
 
18
  Software distributed under the License is distributed on an "AS IS"
 
19
  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 
20
  the License for the specific language governing rights and limitations
 
21
  under the License.
 
22
 
 
23
  The Initial Developer of the Original Code is Ericsson AB.
 
24
    </legalnotice>
 
25
 
 
26
    <title>Toolbar</title>
 
27
    <prepared>Gunilla Hugosson, Kenneth Lundin</prepared>
 
28
    <docno></docno>
 
29
    <date>1997-04-21</date>
 
30
    <rev>A</rev>
 
31
    <file>ch5toolb.ae</file>
 
32
  </header>
 
33
  <p>Toolbar provides an interface to the various Erlang tools which are available. Toolbar can also provide access to user supplied tools which are included with the Erlang software release. These tools are called GS Contributions.</p>
 
34
  <p>All tools included in Toolbar must have a configuration file which contains information about the tool, such as its start function and the location of help information. The name of a configuration file must include the suffix <c>.tool</c>.
 
35
    </p>
 
36
  <p>Start the Toolbar application with one of the following commands:
 
37
    </p>
 
38
  <list type="bulleted">
 
39
    <item>enter the command <c>toolbar:start().</c> from the command line after Erlang has been started.</item>
 
40
    <item>start Erlang with the command <c>erl -s toolbar</c>.</item>
 
41
  </list>
 
42
  <p>When started, Toolbar automatically checks for <c>*.tool</c> files in the current path and adds the corresponding tools. For each <c>ebin</c> directory found in the path, it will also look in a <c>priv</c> directory next to it. This is a function of the Erlang file structure.
 
43
    </p>
 
44
  <p>You can update Toolbar with menu commands on Toolbar window. Refer to the File Menu and Tools Menu sections below for details.
 
45
    </p>
 
46
 
 
47
  <section>
 
48
    <title>Toolbar Window</title>
 
49
    <p>The following illustration shows <seealso marker="#fig_1">The Toolbar Window</seealso>.
 
50
      </p>
 
51
    <marker id="fig_1"></marker>
 
52
    <image file="bar">
 
53
      <icaption>The Toolbar Window</icaption>
 
54
    </image>
 
55
    <p>Each icon on Toolbar represents a separate tool, which is started by clicking on the icon. You can also display place the mouse pointer over an icon to display the name of the tool at the bottom of Toolbar window.
 
56
      </p>
 
57
    <p>The Toolbar window also has a menu which includes the following menu items:
 
58
      </p>
 
59
    <list type="bulleted">
 
60
      <item>File menu</item>
 
61
      <item>Tools menu</item>
 
62
      <item>Help menu</item>
 
63
    </list>
 
64
    <p>These menu are described in the following sections.
 
65
      </p>
 
66
 
 
67
    <section>
 
68
      <marker id="file_menu"></marker>
 
69
      <title>The File menu</title>
 
70
      <p>The File menu has the following two menu items:
 
71
        </p>
 
72
      <taglist>
 
73
        <tag>Update Toolbar</tag>
 
74
        <item>Select this menu item to search for new tool files in the current path and add the corresponding tools to the Toolbar window. This action is performed automatically every the Toolbar application is started.</item>
 
75
        <tag>Quit</tag>
 
76
        <item>Select this menu item to exit the oolbar application.</item>
 
77
      </taglist>
 
78
    </section>
 
79
 
 
80
    <section>
 
81
      <marker id="tools_menu"></marker>
 
82
      <title>The Tools menu</title>
 
83
      <p>The Tool menu has the following menu items:
 
84
        </p>
 
85
      <taglist>
 
86
        <tag>Create Tool File</tag>
 
87
        <item>Choose this menu item to display the Create Tools File Window, where you create a new tools file, or edit an existing tools file. This window is described in detail below.</item>
 
88
        <tag>Add GS Contributions</tag>
 
89
        <item>Choose this menu item to add GS contributions by entering the path to the directory where these tools are situated. GS contributions are user supplied tools which are included with the Erlang software release. These tools are not supported by Erlang/OTP.</item>
 
90
      </taglist>
 
91
 
 
92
      <section>
 
93
        <title>The Create Tool File Window</title>
 
94
        <p>This window is displayed when you select <em>Create Tool File</em> from the <em>Tools</em> menu. The following illustration shows <seealso marker="#fig_2">The Create Tool File  Window</seealso>.
 
95
          </p>
 
96
        <marker id="fig_2"></marker>
 
97
        <image file="create_tool">
 
98
          <icaption>The Create Tool File Window</icaption>
 
99
        </image>
 
100
        <p>Follow these steps to create a new tool file, or to edit an existing tool file:</p>
 
101
        <list type="bulleted">
 
102
          <item>To edit an existing tools file, enter the file name of the tools file into the field <em>File name</em> and press <em>Enter</em>. The contents of the tool file are displayed in the information fields. Edit the information in the following fields as required.</item>
 
103
          <item>To create a new tools file, enter information into the following fields.</item>
 
104
          <item>When finished, select <em>Update Toolbar</em> from the <em>File</em> menu.</item>
 
105
        </list>
 
106
        <list type="ordered">
 
107
          <item><em>File name</em>. Enter the name of the tools file. The application will add the <c>.tool</c> suffix if omitted.</item>
 
108
          <item><em>Tool name</em>. Enter the name of the tool. This field defaults to the name entered into the File name field. For example, if you enter <c>mytool.tool</c> as a file name, this field defaults to <c>mytool</c>.</item>
 
109
          <item><em>Start function</em>. Enter a module name and a function name into the fields titled module and function respectively. The function must exist and take zero arguments.</item>
 
110
          <item><em>Icon file</em>. Enter the file name of the icon to be displayed in the Toolbar. The file must be a bitmap file or a GIF image with the file extension <c>.xbm</c> or <c>.gif</c> respectively. If no path name is entered, the system assumes that the file is located in the same directory as the tools file. This field is optional.</item>
 
111
          <item><em>Message</em>. Enter a descriptive string of maximum 30 characters for the tool.  This field is optional. The information entered here is displayed at the bottom of the Toolbar window when the mouse pointer is placed on the Toolbar icon.</item>
 
112
          <item><em>HTML</em>. Enter an URL, a HTML file name, or a plain text file name, which points to the help text file for the tool. An URL should be given in the form <c>http://...</c>. If no path is given, the system assumes that the file is located in the same directory as the tool file. For an HTML file name ending with <c>.html</c>, it is possible to add an index which points to a specific location in the file. This is written as <c>.html#index</c>. This field is optional.</item>
 
113
        </list>
 
114
        <p>The window has the following command buttons:
 
115
          </p>
 
116
        <list type="bulleted">
 
117
          <item><em>Clear</em>. Click on this button to clear the information fields.</item>
 
118
          <item><em>Save</em>. Click on this button to save the information. A new tool file can be saved only when mandatory information such as file name, tool name and start function has been entered.</item>
 
119
          <item><em>Stop</em>. Click on this button to quit the Create Tool File window.</item>
 
120
        </list>
 
121
        <note>
 
122
          <p>No error check is performed on the information entered.</p>
 
123
          <p>You must select <em>Update Toolbar</em> from the <em>File</em> menu to update the configuration and make the tool visible on the Toolbar.</p>
 
124
        </note>
 
125
      </section>
 
126
    </section>
 
127
 
 
128
    <section>
 
129
      <marker id="help_menu"></marker>
 
130
      <title>The Help menu</title>
 
131
      <p>The Help Menu has the following two menu items, plus additional help menu items for those tools which have a help system.
 
132
        </p>
 
133
      <taglist>
 
134
        <tag>About</tag>
 
135
        <item>This menu item displays a short message about accessing the help information.</item>
 
136
        <tag>Toolbar</tag>
 
137
        <item>This menu item provides access to the Toolbar documentation.</item>
 
138
      </taglist>
 
139
    </section>
 
140
  </section>
 
141
</chapter>
 
142