You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by se...@apache.org on 2007/01/23 00:40:14 UTC
svn commit: r498853 [3/7] - in
/directory/ldapstudio/trunk/ldapstudio-browser-help: resources/icons/
resources/images/ src/main/resources/
Modified: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/0_index.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/0_index.xml?view=diff&rev=498853&r1=498852&r2=498853
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/0_index.xml (original)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/0_index.xml Mon Jan 22 15:39:53 2007
@@ -1,44 +1,113 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "../../../docbook-xml/docbookx.dtd"[]>
-
-<book>
-
- <bookinfo>
- <title>LDAP Browser Users Guide</title>
- <copyright>
- <year>2007</year>
- <holder>Apache Software Foundation</holder>
- </copyright>
- <legalnotice>
- <para>
- LDAP Browser this user guide are distributed under the Apache License.
- </para>
- </legalnotice>
- </bookinfo>
-
- <chapter id="ch1">
- <title>Chapter 1</title>
-
- <para>
- This getting started guide provides a short introduction to the LDAP Browser.
- </para>
-
- <section id="sec1">
- <title>Section 1</title>
-
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "../../../docbook-xml/docbookx.dtd"[
+
+ <!ENTITY gettingstarted SYSTEM "1_gettingstarted.xml">
+
+ <!ENTITY tools SYSTEM "2_tools.xml">
+
+ <!ENTITY tools_ldap_perspective SYSTEM "2.10_tools_ldap_perspective.xml">
+
+ <!ENTITY tools_connections_view SYSTEM "2.20_tools_connections_view.xml">
+
+ <!ENTITY tools_browser_view SYSTEM "2.21_tools_browser_view.xml">
+ <!ENTITY tools_browser_view_overview SYSTEM "2.21.0_tools_browser_view_overview.xml">
+ <!ENTITY tools_browser_view_dit SYSTEM "2.21.1_tools_browser_view_dit.xml">
+ <!ENTITY tools_browser_view_searches SYSTEM "2.21.2_tools_browser_view_searches.xml">
+ <!ENTITY tools_browser_view_bookmarks SYSTEM "2.21.3_tools_browser_view_bookmarks.xml">
+ <!ENTITY tools_browser_view_contextmenu SYSTEM "2.21.9_tools_browser_view_contextmenu.xml">
+
+ <!ENTITY tools_entry_editor SYSTEM "2.22_tools_entry_editor.xml">
+ <!ENTITY tools_entry_editor_overview SYSTEM "2.22.0_tools_entry_editor_overview.xml">
+ <!ENTITY tools_entry_editor_features SYSTEM "2.22.1_tools_entry_editor_features.xml">
+ <!ENTITY tools_entry_editor_contextmenu SYSTEM "2.22.9_tools_entry_editor_contextmenu.xml">
+
+ <!ENTITY tools_search_result_editor SYSTEM "2.23_tools_search_result_editor.xml">
+ <!ENTITY tools_search_result_editor_overview SYSTEM "2.23.0_tools_search_result_editor_overview.xml">
+ <!ENTITY tools_search_result_editor_features SYSTEM "2.23.1_tools_search_result_editor_features.xml">
+ <!ENTITY tools_search_result_editor_contextmenu SYSTEM "2.23.9_tools_search_result_editor_contextmenu.xml">
+
+ <!ENTITY tools_schema_browser SYSTEM "2.24_tools_schema_browser.xml">
+
+ <!ENTITY tools_modification_logs_view SYSTEM "2.25_tools_modification_logs_view.xml">
+
+ <!ENTITY tools_progress_view SYSTEM "2.26_tools_progress_view.xml">
+
+ <!ENTITY tools_ldif_editor SYSTEM "2.27_tools_ldif_editor.xml">
+
+ <!ENTITY tools_newconnection_wizard SYSTEM "2.40_tools_newconnection_wizard.xml">
+ <!ENTITY tools_newentry_wizard SYSTEM "2.41_tools_newentry_wizard.xml">
+ <!ENTITY tools_attribute_wizard SYSTEM "2.42_tools_attribute_wizard.xml">
+ <!ENTITY tools_search_dialog SYSTEM "2.43_tools_search_dialog.xml">
+ <!ENTITY tools_batchoperation_wizard SYSTEM "2.44_tools_batchoperation_wizard.xml">
+
+ <!ENTITY tools_ldifimport_wizard SYSTEM "2.45_tools_ldifimport_wizard.xml">
+ <!ENTITY tools_dsmlimport_wizard SYSTEM "2.45.1_tools_dsmlimport_wizard.xml">
+ <!ENTITY tools_ldifexport_wizard SYSTEM "2.46_tools_ldifexport_wizard.xml">
+ <!ENTITY tools_dsmlexport_wizard SYSTEM "2.46.1_tools_dsmlexport_wizard.xml">
+ <!ENTITY tools_csvexport_wizard SYSTEM "2.47_tools_csvexport_wizard.xml">
+ <!ENTITY tools_excelexport_wizard SYSTEM "2.48_tools_excelexport_wizard.xml">
+
+ <!ENTITY tools_referrals_connection_dialog SYSTEM "2.49_tools_referrals_connection_dialog.xml">
+ <!ENTITY tools_filter_editor_dialog SYSTEM "2.50_tools_filter_editor_dialog.xml">
+
+ <!ENTITY tools_value_editors SYSTEM "2.70_tools_value_editors.xml">
+
+ <!ENTITY tools_connection_properties SYSTEM "2.80_tools_connection_properties.xml">
+ <!ENTITY tools_entry_properties SYSTEM "2.81_tools_entry_properties.xml">
+ <!ENTITY tools_attribute_properties SYSTEM "2.82_tools_attribute_properties.xml">
+ <!ENTITY tools_value_properties SYSTEM "2.83_tools_value_properties.xml">
+ <!ENTITY tools_search_properties SYSTEM "2.84_tools_search_properties.xml">
+ <!ENTITY tools_bookmark_properties SYSTEM "2.85_tools_bookmark_properties.xml">
+
+ <!ENTITY tools_preferences SYSTEM "2.90_tools_preferences.xml">
+
+ <!ENTITY tasks SYSTEM "3_tasks.xml">
+ <!ENTITY reference SYSTEM "4_reference.xml">
+ <!ENTITY tipsntricks SYSTEM "5_tipsntricks.xml">
+ <!ENTITY whatsnew SYSTEM "6_whatsnew.xml">
+
+]>
+
+<!--
+ 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.
+-->
+
+<book>
+
+ <bookinfo>
+ <title>LDAP Studio Browser User's Guide</title>
+ <copyright>
+ <year>2007</year>
+ <holder>Apache Software Foundation</holder>
+ </copyright>
+ <legalnotice>
<para>
- Bla bla
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata
- fileref="images/product_lg.gif" format="GIF" />
- </imageobject>
- </mediaobject>
- </screenshot>
- </para>
-
- </section>
- </chapter>
-
-</book>
+ This user guide is distributed under the Apache License, Version 2.0.
+ You can find the license details online at <ulink url="http://apache.org/licenses/LICENSE-2.0.txt">http://apache.org/licenses/LICENSE-2.0.txt</ulink>.
+ </para>
+ </legalnotice>
+ </bookinfo>
+
+ &gettingstarted;
+ &tools;
+ &tasks;
+ &reference;
+ &tipsntricks;
+ &whatsnew;
+
+</book>
Added: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/1_gettingstarted.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/1_gettingstarted.xml?view=auto&rev=498853
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/1_gettingstarted.xml (added)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/1_gettingstarted.xml Mon Jan 22 15:39:53 2007
@@ -0,0 +1,328 @@
+<!--
+ 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.
+-->
+<chapter id="gettingstarted">
+ <title>Getting started</title>
+
+ <para>
+ This getting started guide provides a brief introduction to the LDAP Studio Browser.
+ </para>
+
+ <section id="gettingstarted_download_install">
+ <title>Download and installation</title>
+ <para>
+ Beside the integration in LDAP Studio the LDAP Studio Browser could also be installed
+ as a plug-in into a regular Eclipse installation. This section describes this
+ alternative.
+ </para>
+ <para>
+ Using the Eclipse Install/Update Manager is the easiest way to
+ install the LDAP Studio Browser plug-in.
+ From workbench menu choose
+ <emphasis role="strong">
+ <menuchoice>
+ <guimenu>Help</guimenu>
+ <guisubmenu>Software Updates</guisubmenu>
+ <guimenuitem>Find and Install...</guimenuitem>
+ </menuchoice>
+ </emphasis>
+ .
+ </para>
+ <para>
+ In the opened wizard choose
+ <emphasis role="strong">Search for new features to install</emphasis>
+ and click <emphasis role="strong">Next</emphasis>.
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/gettingstarted_install_1.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ Next please specify the LDAP Studio update site. Click the <emphasis role="strong">New Remote Site...</emphasis> button.
+ In the dialog input the following and press <emphasis role="strong">OK</emphasis>:
+ <itemizedlist>
+ <listitem>Name: LDAP Studio Update Site</listitem>
+ <listitem>URL: http://people.apache.org/~pamarcelot/ldapstudio/update/</listitem>
+ </itemizedlist>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/gettingstarted_install_2.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ Make sure the new update site is checked an press
+ <emphasis role="strong">Finish</emphasis>.
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/gettingstarted_install_3.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ Now the install manager checks the update site and presents the search results. Select the
+ feature you want to install - of course the LDAP Studio Browser - and click
+ <emphasis role="strong">Next</emphasis>.
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/gettingstarted_install_4.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ Accept the license agreement, the LDAP Studio Browser is distributed under the
+ Apache License, Version 2.0.
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/gettingstarted_install_5.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ In the next dialog ensure that the LDAP Studio Browser feature is selected and
+ click to <emphasis role="strong">Finish</emphasis>.
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/gettingstarted_install_6.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ Now the install manager loads the necessary files. When download is finished
+ you have to verify the installation, please click to
+ <emphasis role="strong">Install</emphasis>.
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/gettingstarted_install_7.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ After installation it is recommended to restart the Eclipse workbench.
+ </para>
+
+ </section>
+
+ <section id="gettingstarted_open_perspecitve">
+ <title>Open LDAP perspective</title>
+ <para>
+ To use the LDAP Studio Browser plug-in open the LDAP perspective. Therefore go to
+ <emphasis role="strong">
+ <menuchoice>
+ <guimenu>Window</guimenu>
+ <guisubmenu>Open Perspective</guisubmenu>
+ <guimenuitem>Other...</guimenuitem>
+ </menuchoice>
+ </emphasis>
+ and select the <emphasis role="strong">LDAP</emphasis> perspective.
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/gettingstarted_open_perspective_1.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ For more information about the LDAP perspective see <link linkend="tools_ldap_perspective">LDAP perspective</link>
+ </para>
+ </section>
+
+ <section id="gettingstarted_create_connection">
+ <title>Create connection</title>
+ <para>
+ The bottom left corner shows all of the LDAP connections. As can be seen, the view is empty, meaning a connection still needs to be specified.
+ </para>
+ <para>
+ To create a new connection click the
+ <inlinemediaobject><imageobject><imagedata fileref="icons/connection_add.gif" format="GIF"/></imageobject></inlinemediaobject>
+ <emphasis role="strong">New Connection</emphasis> button.
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/gettingstarted_create_connection_1.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ In the wizard's first page enter a connection name as well as the hostname and the port of the LDAP server. To check the connection
+ parameter you entered you may click to <emphasis role="strong"><guibutton>Check Network Parameter</guibutton></emphasis>.
+ Click <emphasis role="strong">Next</emphasis> when done.
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/gettingstarted_create_connection_2.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ In the wizard's second page select the authentication method. If you choose the simple bind method also enter your bind DN or user and bind password.
+ To check the authentication parameter you entered you may click to <emphasis role="strong"><guibutton>Check Authentication</guibutton></emphasis>.
+ Click <emphasis role="strong">Finish</emphasis> when done.
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/gettingstarted_create_connection_3.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ Observe that the <emphasis role="strong">Connections view</emphasis> now shows the created connection.
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/gettingstarted_create_connection_4.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ For more information see <link linkend="tools_connections_view">Connections view</link>
+ </para>
+ </section>
+
+ <section id="gettingstarted_browse">
+ <title>Browse the directory</title>
+ <para>
+ The <emphasis role="strong">LDAP Browser view</emphasis> is on the top left.
+ The category <inlinemediaobject><imageobject><imagedata fileref="icons/dit.gif" format="GIF"/></imageobject></inlinemediaobject>
+ <emphasis role="strong">DIT</emphasis> shows the hierarchical content of the directory. You may expand and collapse the tree.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/gettingstarted_browse_1.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ When selecting an entry its attributes and values will be displayed in the <emphasis role="strong">Entry editor</emphasis>.
+ </para>
+ <para>
+ For more information see <link linkend="tools_browser_view">LDAP Browser view</link> and <link linkend="tools_entry_editor">Entry editor</link>.
+ </para>
+ </section>
+
+ <section id="gettingstarted_search">
+ <title>Search the directory</title>
+
+ <para>
+ To search the directory you may use the Eclipse search function.
+ </para>
+ <orderedlist numeration="arabic">
+ <listitem>
+ <para>
+ In the Workbench toolbar, click the
+ <inlinemediaobject><imageobject><imagedata fileref="icons/search.gif" format="GIF"/></imageobject></inlinemediaobject>
+ <emphasis role="strong">Search</emphasis> button.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ If it is not already selected, select the
+ <inlinemediaobject><imageobject><imagedata fileref="icons/browser_searchresulteditor.gif" format="GIF"/></imageobject></inlinemediaobject>
+ <emphasis role="strong">LDAP Search</emphasis> tab.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/gettingstarted_search_1.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ In the search dialog type in a search name. Select a connection to search on and the search base DN.
+ Specify a valid LDAP filter and the returning attributes as comma separated list, hit Ctrl-Space to get content assistance.
+ Additionally you may choose scope, limits, alias and referral options.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Press the <emphasis role="strong">Search</emphasis> button.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The category <inlinemediaobject><imageobject><imagedata fileref="icons/searches.gif" format="GIF"/></imageobject></inlinemediaobject>
+ <emphasis role="strong">Searches</emphasis> in the LDAP Browser shows the searches. You may expand the search to see all search result enties.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/gettingstarted_search_2.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ When selecting a search the search results and returning attributes will be displayed in the <emphasis role="strong">Search Result editor</emphasis>.
+ </para>
+ <para>
+ When selecting a search result entry its attributes and values will be displayed in the <emphasis role="strong">Entry editor</emphasis>.
+ </para>
+ </listitem>
+
+ </orderedlist>
+
+ <para>
+ For more information see <link linkend="tools_browser_view">LDAP Browser view</link> and <link linkend="tools_search_result_editor">Search Result editor</link>.
+ </para>
+ </section>
+
+</chapter>
Added: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.10_tools_ldap_perspective.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.10_tools_ldap_perspective.xml?view=auto&rev=498853
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.10_tools_ldap_perspective.xml (added)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.10_tools_ldap_perspective.xml Mon Jan 22 15:39:53 2007
@@ -0,0 +1,75 @@
+<section id="tools_ldap_perspective">
+ <title>LDAP perspective</title>
+ <para>
+ The LDAP Studio Browser plug-in provides a LDAP perspective. It is designed for working
+ with an LDAP directory (browse, edit, search) as well as for editing LDIF
+ files. The views and edtiors are arranged as follows:
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_ldap_perspective_1.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ The bottom left view shows all the <emphasis role="strong">Connections</emphasis>.
+ It is used to create, edit, delete, open and close connections.
+ When selecting a single connection the LDAP Browser shows the content of the
+ selected connection.
+ </para>
+ <para>
+ The <emphasis role="strong">LDAP Browser view</emphasis> is on the top left.
+ It shows the directory information tree (DIT), the persistent searches
+ and bookmarks of the selected connection.
+ With the LDAP Browser you are able to navigate and modify the DIT,
+ perform searches and manage bookmarks.
+ When selecting a single entry the Entry editor shows its attributes
+ and values. When selecting a single search the Search Result editor
+ shows the search results.
+ </para>
+ <para>
+ The editor area in the top middle. The following LDAP specific editors
+ are available:
+ <itemizedlist>
+ <listitem>
+ <para>The <emphasis role="strong">Entry editor</emphasis>
+ displays the attributes and values of the currently selected entry.
+ Further it is possilbe to add, edit and delete attributes</para>
+ </listitem>
+ <listitem>
+ <para>The <emphasis role="strong">Search Result editor</emphasis>
+ shows the result of the currently selected search in a table.
+ Further it is possible to edit the search result in a
+ spreadsheet-like manner.</para>
+ </listitem>
+ <listitem>
+ <para>With the <emphasis role="strong">Schema Browser</emphasis>
+ you could browse the schema with its object class and attribute
+ definitions.</para>
+ </listitem>
+ <listitem>
+ <para>The <emphasis role="strong">LDIF editor</emphasis> is a
+ rich editor to create LDIF files. It provides well-known Eclipse
+ features like syntax highlighting and content assistance</para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ The <emphasis role="strong">Outline view</emphasis> on the top right
+ displays the structure of the entry currently opended in the entry editor or
+ the structured outline of the currently opened LDIF file.
+ </para>
+ <para>
+ The bottom centered view displays all <emphasis role="strong">Modifications</emphasis>
+ made on the currently selected connections as LIDF change records.
+ </para>
+ <para>
+ The bottom right <emphasis role="strong">Progress view</emphasis> displays
+ long-running operations like connecting to the directory or
+ import/export operations.
+ </para>
+</section>
\ No newline at end of file
Added: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.20_tools_connections_view.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.20_tools_connections_view.xml?view=auto&rev=498853
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.20_tools_connections_view.xml (added)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.20_tools_connections_view.xml Mon Jan 22 15:39:53 2007
@@ -0,0 +1,248 @@
+<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>
\ No newline at end of file
Added: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.21.0_tools_browser_view_overview.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.21.0_tools_browser_view_overview.xml?view=auto&rev=498853
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.21.0_tools_browser_view_overview.xml (added)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.21.0_tools_browser_view_overview.xml Mon Jan 22 15:39:53 2007
@@ -0,0 +1,409 @@
+<section id="tools_browser_view_overview">
+ <title>Overview</title>
+
+ <para>
+ This section describes general aspects of the LDAP Browser view.
+ </para>
+
+ <simplesect id="tools_browser_view_screenshot">
+ <title>Example screenshot</title>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/tools_browser_view_1.png"
+ format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_browser_view_icons">
+ <title>Icons</title>
+ <para>
+ The following icons can appear in the LDAP Browser 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/dit.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>
+ The top-level category containing the
+ directory information tree.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/entry_person.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/entry_org.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/entry_dc.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/entry_default.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>
+ Entry, the icon depends on its RDN
+ attribute.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/entry_alias.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/entry_ref.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>Alias or referral entry.</entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/browser_schemabrowsereditor.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>The schema entry.</entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/entry_root.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>The root DSE entry.</entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/folder.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>A container for folded entries.</entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/searches.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>
+ The top-level category containing persistent
+ searches.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/search.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>A search.</entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/bookmarks.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>
+ The top-level category containing bookmarks.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/bookmark.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>A Bookmark.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </simplesect>
+
+ <simplesect id="tools_browser_view_toolbar">
+ <title>Toolbar</title>
+ <para>
+ The toolbar contains the following items:
+ <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/parent.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>Up</entry>
+ <entry>
+ Selects the parent node of the currently selected
+ node.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/collapseall.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>Collapse All</entry>
+ <entry>
+ Collapses the whole tree, only the three
+ top-level categories remain visible.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/refresh.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>Refresh</entry>
+ <entry>
+ Refreshes the selected objects
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_browser_view_drop_down_menu">
+ <title>Drop Down Menu</title>
+ <para>
+ The drop down menu contains the following items:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Sorting...: Opens the
+ <link linkend="tools_browser_view_sortdialog">
+ Sort Dialog
+ </link>
+ .
+ </para>
+ </listitem>
+ <listitem>
+ <para>Show DIT: Shows the DIT category.</para>
+ </listitem>
+ <listitem>
+ <para>
+ Show Searches: Shows the Searches category.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Show Bookmarks: Shows the Bookmarks category.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Show Directory Metadata: Shows the directory
+ metadata entries (e.g. the root DSE or the
+ schema entry) inside the DIT category.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Preferences...: Opens the
+ <link linkend="preferences_browser_view">
+ LDAP Browser preferences
+ </link>
+ dialog.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+
+
+ <simplesect id="tools_browser_view_sortdialog">
+ <title>Sort dialog</title>
+ <para>
+ With the sort dialog you can set the sorting behaviour of
+ the LDAP Browser view.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_browser_view_2.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <informaltable frame="all">
+ <tgroup cols="3">
+ <colspec colname="Field" />
+ <colspec colname="Description" />
+ <colspec colname="Default" />
+ <thead>
+ <row>
+ <entry>Field</entry>
+ <entry>Description</entry>
+ <entry>Default</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Leaf entries first</entry>
+ <entry>
+ If enabled, entries without children are
+ grouped before the entries with children.
+ </entry>
+ <entry>on</entry>
+ </row>
+ <row>
+ <entry>Meta entries last</entry>
+ <entry>
+ If enabled, meta entries (e.g. root DSE or
+ schema entry) are grouped after all other
+ entries.
+ </entry>
+ <entry>on</entry>
+ </row>
+ <row>
+ <entry>Sort by</entry>
+ <entry>
+ Sort criteria and order of entries in DIT
+ and search results. Select either 'RDN' or
+ 'RDN Value' from the drop-down list as sort
+ critera and select the sort order. Or select
+ 'No sorting' to disable sorting.
+ </entry>
+ <entry>RDN Value and Ascending</entry>
+ </row>
+ <row>
+ <entry>Sort limit</entry>
+ <entry>
+ If there are more than the specified number
+ of children or search results they won't
+ be sorted. Hint: For performance reasons the
+ maximum value should be 10000!
+ </entry>
+ <entry>10000</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </simplesect>
+</section>
\ No newline at end of file
Added: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.21.1_tools_browser_view_dit.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.21.1_tools_browser_view_dit.xml?view=auto&rev=498853
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.21.1_tools_browser_view_dit.xml (added)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.21.1_tools_browser_view_dit.xml Mon Jan 22 15:39:53 2007
@@ -0,0 +1,310 @@
+<section id="tools_browser_view_dit">
+ <title>DIT category</title>
+
+ <para>
+ This section describes the DIT category in the LDAP Browser
+ view.
+ </para>
+
+ <simplesect id="tools_browser_view_dit_navigation">
+ <title>Navigation</title>
+ <para>
+ In the DIT category the directory information tree of the
+ LDAP directory is displayed in its natural hierarchical
+ structure. The first hierachy level contains the base
+ entries, the Root DSE and the schema entry. When expanding
+ an entry its direct children are fetched from directory. To
+ expand and collapse an entry you could also double-click.
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_browser_view_dit_child_detection">
+ <title>Children detection</title>
+ <para>
+ While browsing the directory the LDAP Browser tries to find
+ out if a fetched entry has children. Entries without
+ children couldn't be expanded. This behaviour could be
+ changed in the
+ <link linkend="preferences_browser_view">
+ LDAP Browser preferences
+ </link>
+ .
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_browser_view_dit_labels">
+ <title>Labels</title>
+ <para>
+ By default the RDN of the entries is used as label and the
+ length of the label is limited to 50 characters. This
+ behaviour could be changed in the
+ <link linkend="preferences_browser_view">
+ LDAP Browser preferences
+ </link>
+ . For the Base entries always the whole DN is used as label.
+ </para>
+ <para>
+ If an entry has child entries the number of children is
+ appended in parentheses to the label. If the directory
+ server returned a partial result (e.g. because of count or
+ time limits) a plus (+) character is appended to the number
+ of children to indicate that there are more child entries.
+ Note: The limit parameters are inherited from connection
+ properties.
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_browser_view_7.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_browser_view_dit_icons">
+ <title>Icons</title>
+ <para>
+ The following icons are used to distinguish entry types:
+ </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/entry_person.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>Entry with cn, sn or uid as RDN.</entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/entry_org.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>Entry with o or ou as RDN.</entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/entry_dc.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>Entry with c, dc or l as RDN.</entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/entry_alias.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>Alias entry.</entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/entry_ref.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>Referral entry.</entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/browser_schemabrowsereditor.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>The schema entry.</entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/entry_root.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>The root DSE entry.</entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/entry_default.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>All other entries</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </simplesect>
+
+ <simplesect id="tools_browser_view_dit_aliases_and_referrals">
+ <title>Aliases and referrals entries</title>
+ <para>
+ In the DIT category there are two ways to handle aliases and
+ referral objects:
+ <itemizedlist>
+ <listitem>
+ <para>
+ If the option "Show alias and referral objects"
+ is checked in the
+ <link linkend="preferences_browser_view">
+ LDAP Browser preferences
+ </link>
+ , aliases and referrals and their target entry
+ are explicitly displayed. Aliases and referrals
+ could by identified by the
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/entry_alias.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ or
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/entry_ref.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ icon. The target entry is appended as a child of
+ the alias or referral entry. The target entry of
+ an alias entry is labeled by its complete DN.
+ The target entry of a referral entry is labeled
+ by its URL. In case of referrals the
+ <link
+ linkend="tools_referral_connection_dialog">
+ Select Referral Connection dialog
+ </link>
+ appears to select the target connection matching
+ the referral URL.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ If the previous option isn't checked the
+ handling of aliases and referrals is determined
+ by the
+ <link
+ linkend="tools_connection_properties_options">
+ Connection properties
+ </link>
+ .
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_browser_view_dit_folding">
+ <title>Folding</title>
+ <para>
+ By default the entries of large branches are folded into
+ virtual folders
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/folder.gif"
+ format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ each with 100 entries. This may help to keep the displayed
+ tree smaller. This behaviour could be changed in the
+ <link linkend="preferences_browser_view">
+ LDAP Browser preferences
+ </link>
+ .
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_browser_view_6.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_browser_view_dit_filter">
+ <title>Filter Children</title>
+ <para>
+ With the
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/filter_dit.gif"
+ format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ <emphasis role="strong">Filter Children</emphasis>
+ action you can define a filter to select entries returned by
+ the server for your needs. You could recognise a filtered
+ entry by its modified icon and label.
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_browser_view_10.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ </simplesect>
+
+</section>
\ No newline at end of file
Added: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.21.2_tools_browser_view_searches.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.21.2_tools_browser_view_searches.xml?view=auto&rev=498853
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.21.2_tools_browser_view_searches.xml (added)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.21.2_tools_browser_view_searches.xml Mon Jan 22 15:39:53 2007
@@ -0,0 +1,201 @@
+<section id="tools_browser_view_searches">
+ <title>Searches category</title>
+ <para>
+ This section describes the Searches category in the LDAP Browser
+ view.
+ </para>
+
+ <simplesect id="tools_browser_view_searches_newsearch">
+ <title>New Search</title>
+ <para>
+ To perform a new search please choose one of the following
+ methods:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Select a search or entry and choose
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/search_new.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ <emphasis role="strong">New Search...</emphasis>
+ from the context menu. The selected search or
+ entry is used to preset search parameters.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Use the Workbench
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/search.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ <emphasis role="strong">Search</emphasis>
+ action.
+ </para>
+ </listitem>
+ </itemizedlist>
+ Please see
+ <link linkend="tools_search_dialog">Search dialog</link>
+ how to define the search parameters.
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_browser_view_searches_navigation">
+ <title>Navigation</title>
+ <para>
+ In the Searches category the searches and belonging search
+ results are displayed. The first hierachy level contains the
+ Searches, the second hierarchie level shows the search
+ result entries. To expand and collapse a search the
+ double-click could be used.
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_browser_view_9.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ With the
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/locate_searchresult_in_dit.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ <emphasis role="strong">Open Search Result in DIT</emphasis>
+ action the search result entry could be located in the DIT.
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_browser_view_searches_unperfomed">
+ <title>Unperfomed Searches</title>
+ <para>
+ An unperfomed search could be identified by the gray search
+ icon
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/search_unperformed.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ and the absent number in parentheses at the end of the
+ search name label. To perfom the search expand it or press
+ the refresh button.
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_browser_view_searches_perfomed">
+ <title>Perfomed Searches</title>
+ <para>
+ A perfomed search could be identified by the yellow search
+ icon
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/search.gif"
+ format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ If a search is performed the number of search results is
+ appended in parentheses to the search name label. If the
+ directory server returned a partial result (e.g. because of
+ count or time limits) a plus (+) character is appended to
+ the number of search results to indicate that there are more
+ results. To perfom the search again press the refresh
+ button.
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_browser_view_searches_results">
+ <title>Search Results</title>
+ <para>
+ By default the DN of the search results is used as label and
+ the length of the label is limited to 50 characters. This
+ behaviour could be changed in the
+ <link linkend="preferences_browser_view">
+ LDAP Browser preferences
+ </link>
+ .
+ </para>
+ <para>
+ The icons of the search results depends on the RDN type, see
+ <link linkend="tools_browser_view_dit_icons">
+ DIT category
+ </link>
+ . Additional the search results have a small overlay image
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/ovr16/searchresult.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_browser_view_searches_folding">
+ <title>Folding</title>
+ <para>
+ By default large search results folded into virtual folders
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/folder.gif"
+ format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ each with 100 entries. This may help to keep the displayed
+ tree smaller. This behaviour could be changed in the
+ <link linkend="preferences_browser_view">
+ LDAP Browser preferences
+ </link>
+ .
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_browser_view_8.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_browser_view_searches_batchoperation">
+ <title>Batch Operation</title>
+ <para>
+ With the
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/batch.gif"
+ format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ <emphasis role="strong">New Batch Operation...</emphasis>
+ action you can execute a modify operation to all search
+ results.
+ </para>
+ </simplesect>
+
+</section>
\ No newline at end of file
Added: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.21.3_tools_browser_view_bookmarks.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.21.3_tools_browser_view_bookmarks.xml?view=auto&rev=498853
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.21.3_tools_browser_view_bookmarks.xml (added)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.21.3_tools_browser_view_bookmarks.xml Mon Jan 22 15:39:53 2007
@@ -0,0 +1,49 @@
+<section id="tools_browser_view_bookmarks">
+ <title>Bookmarks category</title>
+
+ <para>
+ This section describes the Bookmark category in the LDAP Browser
+ view.
+ </para>
+
+ <para>
+ Bookmarks could be used to quickly access frequently used
+ entries.
+ </para>
+
+ <simplesect id="tools_browser_view_bookmarks_newbookmark">
+ <title>New Bookmark</title>
+ <para>
+ To create a new bookmark select an entry or search result
+ and choose
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/bookmark_add.gif"
+ format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ <emphasis role="strong">New Bookmark...</emphasis>
+ from the context menu.
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_browser_view_bookmarks_navigation">
+ <title>Navigation</title>
+ <para>
+ With the
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/locate_bookmark_in_dit.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ <emphasis role="strong">Open Bookmark in DIT</emphasis>
+ action the bookmark entry could be located in the DIT.
+ </para>
+ </simplesect>
+
+</section>
\ No newline at end of file