blob: fe522a5705623fbef93d7ae66da84706d656b0c5 [file] [log] [blame]
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<section id="tools_connections_view">
<title>Connections view</title>
<para>
The Connections view shows all the LDAP connections that you have added.
Here is an example screenshot of the Connection view:
</para>
<para>
<screenshot>
<mediaobject>
<imageobject>
<imagedata
fileref="images/tools_connections_view_1.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
<para>
To re-order connections just drag-and-drop connections.
</para>
<simplesect id="tools_connections_view_icons">
<title>Icons</title>
<para>
The following icons can appear in the Connections view:
</para>
<informaltable frame='all' >
<tgroup cols='2' align='left' colsep='1' rowsep='1'>
<colspec colname="Icon" align="center"/>
<colspec colname="Description"/>
<thead>
<row>
<entry>Icon</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/connection_connected.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
<entry>Connections is opened.</entry>
</row>
<row>
<entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/connection_disconnected.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
<entry>Connection is closed.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</simplesect>
<simplesect id="tools_connections_view_toolbar">
<title>Toolbar</title>
<informaltable frame='all' >
<tgroup cols='3'>
<colspec colname="Icon" align="center"/>
<colspec colname="Action"/>
<colspec colname="Description"/>
<thead>
<row>
<entry>Icon</entry>
<entry>Action</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/connection_add.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
<entry>New Connection...</entry>
<entry>Starts the <link linkend="tools_newconnection_wizard">New Connection wizard</link></entry>
</row>
<row>
<entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/connection_connect.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
<entry>Open Connection</entry>
<entry>Opens the selected connection(s)</entry>
</row>
<row>
<entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/connection_disconnect.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
<entry>Close Connection</entry>
<entry>Closes the selected connection(s)</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</simplesect>
<simplesect id="tools_connections_view_contextmenu">
<title>Context Menu</title>
<!--
<para>
<screenshot>
<mediaobject>
<imageobject>
<imagedata
fileref="images/tools_connections_view_2.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
-->
<informaltable>
<tgroup cols='4'>
<colspec colname="Icon" align="center"/>
<colspec colname="Action"/>
<colspec colname="Description"/>
<colspec colname="Shortcut"/>
<thead>
<row>
<entry>Icon</entry>
<entry>Action</entry>
<entry>Description</entry>
<entry>Shortcut</entry>
</row>
</thead>
<tbody>
<row>
<entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/connection_add.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
<entry>New Connection...</entry>
<entry>Starts the <link linkend="tools_newconnection_wizard">New Connection wizard</link></entry>
<entry></entry>
</row>
<row>
<entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/connection_connect.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
<entry>Open Connection</entry>
<entry>Opens the selected connection(s)</entry>
<entry></entry>
</row>
<row>
<entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/connection_disconnect.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
<entry>Close Connection</entry>
<entry>Closes the selected connection(s)</entry>
<entry></entry>
</row>
<row>
<entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/browser_schemabrowsereditor.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
<entry>Open Schema Browser</entry>
<entry>Opens the Schema Browser and shows the schema of the selected connection</entry>
<entry></entry>
</row>
<row>
<entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/copy.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
<entry>Copy Connection</entry>
<entry>Copies the selected connections(s) to the clipboard. To duplicate an existing connection please combine copy and paste.</entry>
<entry>
<shortcut><keycombo><keycap>Ctrl</keycap><keycap>C</keycap></keycombo></shortcut>
or
<shortcut><keycombo><keycap>Ctrl</keycap><keycap>Insert</keycap></keycombo></shortcut>
</entry>
</row>
<row>
<entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/paste.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
<entry>Paste Connection</entry>
<entry>Pastes the copied connections(s) from clipboard. Only enabled if there are connections in clipboard.</entry>
<entry>
<shortcut><keycombo><keycap>Ctrl</keycap><keycap>V</keycap></keycombo></shortcut>
or
<shortcut><keycombo><keycap>Shift</keycap><keycap>Insert</keycap></keycombo></shortcut>
</entry>
</row>
<row>
<entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/delete.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
<entry>Delete Connection</entry>
<entry>Deletes the selected connections(s). Only enabled if the selected connections are closed.</entry>
<entry><shortcut><keycap>Delete</keycap></shortcut></entry>
</row>
<row>
<entry></entry>
<entry>Select All</entry>
<entry>Selects all connections.</entry>
<entry><shortcut><keycombo><keycap>Ctrl</keycap><keycap>A</keycap></keycombo></shortcut></entry>
</row>
<row>
<entry></entry>
<entry>Rename Connection...</entry>
<entry>Opens a dialog to rename the selected connection.</entry>
<entry><shortcut><keycap>F2</keycap></shortcut></entry>
</row>
<row>
<entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/import_ldif.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
<entry><menuchoice>
<guimenu>Import</guimenu>
<guisubmenu>LDIF Import...</guisubmenu>
</menuchoice>
</entry>
<entry>Starts the <link linkend="tools_ldifimport_wizard">LDIF Import wizard</link>.</entry>
<entry></entry>
</row>
<row>
<entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/import_dsml.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
<entry><menuchoice>
<guimenu>Import</guimenu>
<guisubmenu>DSML Import...</guisubmenu>
</menuchoice>
</entry>
<entry>Starts the <link linkend="tools_dsmlimport_wizard">DSML Import wizard</link>.</entry>
<entry></entry>
</row>
<row>
<entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/export_ldif.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
<entry><menuchoice>
<guimenu>Export</guimenu>
<guisubmenu>LDIF Export...</guisubmenu>
</menuchoice>
</entry>
<entry>Starts the <link linkend="tools_ldifexport_wizard">LDIF Export wizard</link>.</entry>
<entry></entry>
</row>
<row>
<entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/export_dsml.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
<entry><menuchoice>
<guimenu>Export</guimenu>
<guisubmenu>DSML Export...</guisubmenu>
</menuchoice>
</entry>
<entry>Starts the <link linkend="tools_dsmlexport_wizard">DSML Export wizard</link>.</entry>
<entry></entry>
</row>
<row>
<entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/export_csv.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
<entry><menuchoice>
<guimenu>Export</guimenu>
<guisubmenu>CSV Export...</guisubmenu>
</menuchoice>
</entry>
<entry>Starts the <link linkend="tools_csvexport_wizard">CSV Export wizard</link>.</entry>
<entry></entry>
</row>
<row>
<entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/export_xls.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
<entry><menuchoice>
<guimenu>Export</guimenu>
<guisubmenu>Excel Export...</guisubmenu>
</menuchoice>
</entry>
<entry>Starts the <link linkend="tools_excelexport_wizard">Excel Export wizard</link>.</entry>
<entry></entry>
</row>
<row>
<entry></entry>
<entry>Properties</entry>
<entry>Opens the <link linkend="tools_connection_properties">connection properties</link> dialog.</entry>
<entry>
<shortcut><keycombo><keycap>Alt</keycap><keycap>Enter</keycap></keycombo></shortcut>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</simplesect>
</section>