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 [5/7] - in
/directory/ldapstudio/trunk/ldapstudio-browser-help: resources/icons/
resources/images/ src/main/resources/
Added: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.23.0_tools_search_result_editor_overview.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.23.0_tools_search_result_editor_overview.xml?view=auto&rev=498853
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.23.0_tools_search_result_editor_overview.xml (added)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.23.0_tools_search_result_editor_overview.xml Mon Jan 22 15:39:53 2007
@@ -0,0 +1,273 @@
+<section id="tools_search_result_editor_overview">
+ <title>Overview</title>
+
+ <para>
+ This section describes general aspects of the Search Result
+ editor.
+ </para>
+
+ <simplesect id="tools_search_result_editor_screenshot">
+ <title>Example screenshot</title>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_search_result_editor_1.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_search_result_editor_layout">
+ <title>Layout</title>
+ <para>
+ The Search Result editor has a multi-column layout, one
+ column for each returning attribute defined in search
+ parameters. Each line represents a search result with its
+ values.
+ </para>
+ <para>
+ The cells have the following meaning:
+ <itemizedlist>
+ <listitem>
+ <para>
+ A value indicates that the entry has such an
+ attribute with exacly one value.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ An empty cell indicates that the entry hasn't
+ such an attribute.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ X values: ... indicates that the entry has
+ multiple values for that attribute.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ You can choose whether the DN of each search result is
+ displayed as first column. Toggle
+ <emphasis role="strong">Toolbar menu -> Show DN</emphasis>
+ .
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_search_result_editor_fonts">
+ <title>Fonts and Colors</title>
+ <para>
+ To distinguish the different attribute classes the Search
+ Result editor uses the same fonts and colos as the
+ <link linkend="tools_entry_editor_fonts">Entry editor</link>
+ .
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_search_result_editor_toolbar">
+ <title>Toolbar</title>
+ <para>
+ The toolbar contains the following items:
+ <informaltable frame="all">
+ <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/value_add.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>New Value</entry>
+ <entry>
+ Adds a new value to the selected
+ attribute and starts the edit mode.
+ </entry>
+ <entry>
+ <shortcut>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>+</keycap>
+ </keycombo>
+ </shortcut>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/delete.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>Delete</entry>
+ <entry>
+ Deletes the selected attribute.
+ </entry>
+ <entry>
+ <shortcut>
+ <keycap>Delete</keycap>
+ </shortcut>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/refresh.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>Refresh</entry>
+ <entry>Performs the current search.</entry>
+ <entry>
+ <shortcut>
+ <keycap>F5</keycap>
+ </shortcut>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/copy_table.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>Copy Table</entry>
+ <entry>
+ Copies values as displayed in the table
+ as CSV. By default the tabulator is used
+ as attribute delimiter, a pipe is used
+ as value delimiter and each attribute is
+ wrapped by double-quotes. These settings
+ are suitable to paste the copied data
+ into Excel or OpenOffice, the settings
+ could be changed in
+ <link
+ linkend="preferences_text_formats">
+ Text Formats preferences
+ </link>
+ .
+ </entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/filter.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>Show Quick Filter</entry>
+ <entry>
+ Shows/Hides the
+ <link
+ linkend="tools_search_result_editor_features_quickfilter">
+ Quick Filter
+ </link>
+ .
+ </entry>
+ <entry>
+ <shortcut>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>F</keycap>
+ </keycombo>
+ </shortcut>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_search_result_editor_drop_down_menu">
+ <title>Drop Down Menu</title>
+ <para>
+ The drop down menu contains the following items:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Show DN: If checked the distinguished name of
+ each search result is displayed as first column.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ DN as link: If checked the distinguished name of
+ each search result is a link. Clicking to this link
+ will open the search result entry.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Show Raw Values: If checked the raw values (as
+ stored in directory) are displayed. By default
+ some attributes have a special display value:
+ <itemizedlist>
+ <listitem>
+ Images: Image format, width, height, and
+ size.
+ </listitem>
+ <listitem>Binary data: Data size.</listitem>
+ <listitem>
+ Passwords: Used hash method.
+ </listitem>
+ <listitem>
+ Timestamps: Locale dependent date and
+ time format.
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Preferences...: Opens the
+ <link
+ linkend="preferences_search_result_editor">
+ Search Result editor preferences
+ </link>
+ dialog.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+</section>
Added: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.23.1_tools_search_result_editor_features.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.23.1_tools_search_result_editor_features.xml?view=auto&rev=498853
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.23.1_tools_search_result_editor_features.xml (added)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.23.1_tools_search_result_editor_features.xml Mon Jan 22 15:39:53 2007
@@ -0,0 +1,189 @@
+<section id="tools_search_result_editor_features">
+ <title>Features</title>
+ <para>
+ This section describes the features of the Search Result editor.
+ </para>
+
+ <simplesect id="tools_search_result_editor_features_sorting">
+ <title>Sorting</title>
+ <para>
+ To sort the search results by attributes click the column
+ header. The current sort attribute and direction is
+ indicated by an arrow.
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_search_result_editor_features_quickfilter">
+ <title>Quick Filter</title>
+ <para>
+ If there are many search results it is difficult to find a
+ specific one. The Quick Filter provides a client-side
+ filter. To show/hide the Quick Filter toggle the
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/filter.gif"
+ format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ button or press
+ <shortcut>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>F</keycap>
+ </keycombo>
+ </shortcut>
+ . Enter (even parts of) a value into the input field, only
+ matching search results keep displayed. When hiding the
+ filter is removed.
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_search_result_editor_3.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_search_result_editor_features_navigation">
+ <title>Navigation</title>
+ <para>
+ The
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/locate_dn_in_dit.gif"
+ format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ <emphasis role="strong">Locate DN in DIT</emphasis>
+ action locates and opens the entry of a selected DN in the
+ DIT.
+ </para>
+ <para>
+ The
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/open_searchresult.gif"
+ format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ <emphasis role="strong">Open Search Result</emphasis>
+ action locates and opens the selected search result.
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_search_result_editor_features_copytable">
+ <title>Copy Table</title>
+ <para>
+ The
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/copy_table.gif"
+ format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ <emphasis role="strong">Copy Table</emphasis>
+ action copies attributes as displayed in the table to the
+ system clipboard.
+ </para>
+ <para>
+ By default the tabulator is used as attribute delimiter, a
+ pipe is used as value delimiter and each attribute is
+ wrapped by double-quotes. These settings are suitable to
+ paste the copied data into Excel or OpenOffice, the settings
+ could be changed in
+ <link linkend="preferences_text_formats">
+ Text Formats preferences
+ </link>
+ .
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_search_result_editor_features_editing">
+ <title>Editing</title>
+ <para>
+ It is possible to add, edit or delete the displayed
+ attributes of the search results in the Search Result
+ editor.
+ </para>
+ <para>
+ To enter the edit mode using the default value editor select
+ a cell and press
+ <emphasis role="strong">Enter</emphasis>
+ or
+ <emphasis role="strong">F7</emphasis>
+ or double-click the cell. If the attribute is a simple
+ string (like givenName or telephoneNumber) the value could
+ be edited in-place, otherwise a specific value editor dialog
+ is opened. To use a specific value editor choose one from
+ <emphasis role="strong">
+ Context Menu -> Edit Value With
+ </emphasis>
+ .
+ </para>
+ <para>
+ To finish editing press Enter or click to another cell or
+ click the OK button in a value editor dialog. To cancel
+ editing press ESC or click the Cancel button in a value
+ editor dialog.
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_search_result_editor_features_mve">
+ <title>Multivalued Editor</title>
+ <para>
+ In LDAP it is possible (and even normal) that an entry has
+ multivalued attributes. To handle this in a spreadsheet-like
+ editor a special editor is necessary:
+ <itemizedlist>
+ <listitem>
+ <para>
+ In the cell a multivalued attribute is displayed
+ as "X values: ..." to show the number of values
+ and a preview
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ When entering edit mode the Multivalued Editor
+ dialog is opened.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ The Mulivalued Editor is similar to the Entry editor: you
+ could add, edit and delete values. Of course it is limited
+ to edit only the current attribute, not the whole entry.
+ </para>
+ <para>
+ When editing a multivalued attribute the Multivalued Editor
+ is used as default value editor. When editing a singlevalued
+ attribute you could select
+ <emphasis role="strong">
+ Context Menu -> Edit Value With ->
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/multivaluededitor.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ Multivalued Editor
+ </emphasis>
+ .
+ </para>
+ </simplesect>
+
+</section>
+
Added: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.23.9_tools_search_result_editor_contextmenu.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.23.9_tools_search_result_editor_contextmenu.xml?view=auto&rev=498853
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.23.9_tools_search_result_editor_contextmenu.xml (added)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.23.9_tools_search_result_editor_contextmenu.xml Mon Jan 22 15:39:53 2007
@@ -0,0 +1,1080 @@
+<section id="tools_search_result_editor_contextmenu">
+ <title>Context Menu</title>
+ <para>
+ This section describes the context menu of the Search Result
+ editor.
+ </para>
+
+ <simplesect id="tools_search_result_editor_contextmenu_newvalue">
+ <title>New Value</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/value_add.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Adds a new value to the selected
+ attribute and starts the edit mode. If the
+ attribute already contains one or multiple
+ values the Multivalued Editor is opened.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enabled: If an attribute is selected and the
+ attribute is modifyable
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Shortcut:
+ <shortcut>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>+</keycap>
+ </keycombo>
+ </shortcut>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_search_result_editor_contextmenu_newsearch">
+ <title>New Search...</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/search_new.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Opens the
+ <link linkend="tools_search_dialog">
+ Search dialog
+ </link>
+ . The selected attribute is used to build the
+ search filter (Query by example).
+ </para>
+ </listitem>
+ <listitem>
+ <para>Enabled: If an attribute is selected.</para>
+ </listitem>
+ <listitem>
+ <para>
+ Shortcut:
+ <shortcut>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>H</keycap>
+ </keycombo>
+ </shortcut>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="tools_search_result_editor_contextmenu_newbatchoperation">
+ <title>New Batch Operation...</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/batch.gif"
+ format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Opens the
+ <link
+ linkend="tools_batchoperation_wizard">
+ Batch Operation wizard
+ </link>
+ . If an attribute with one or multiple DNs
+ values are selected these DNs are used as
+ operation objects. Otherwise the selected
+ attribute is used to build the search filter
+ (Query by example).
+ </para>
+ </listitem>
+ <listitem>
+ <para>Enabled: If an attribute is selected.</para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="tools_search_result_editor_contextmenu_locatednindit">
+ <title>Locate DN in DIT</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/locate_dn_in_dit.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Locates the entry of the selected
+ DN in DIT.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Shortcut:
+ <shortcut>
+ <keycap>F3</keycap>
+ </shortcut>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="tools_search_result_editor_contextmenu_opensearchresult">
+ <title>Open Search Result</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/open_searchresult.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Locates and opens the search
+ result.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Shortcut:
+ <shortcut>
+ <keycap>F4</keycap>
+ </shortcut>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="tools_search_result_editor_contextmenu_schemabrowser_ocd">
+ <title>Open Schema Browser -> Object Class Definition</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/ocd.gif"
+ format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Opens the
+ <link linkend="tools_schema_browser_ocd">
+ Object Class page
+ </link>
+ in
+ <link linkend="tools_schema_browser">
+ Schema Browser
+ </link>
+ and selects the object class definition of the
+ currently selected objectClass attribute.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enabled: If the objectClass attribute is
+ selected and the schema contains this object
+ class.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="tools_search_result_editor_contextmenu_schemabrowser_atd">
+ <title>Open Schema Browser -> Attribute Type Definition</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/atd.gif"
+ format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Opens the
+ <link linkend="tools_schema_browser_atd">
+ Attribute Type page
+ </link>
+ in
+ <link linkend="tools_schema_browser">
+ Schema Browser
+ </link>
+ and selects the attribute type definiton of the
+ currently selected attribute.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enabled: If an attribute is selected and the
+ schema contains this attribute type.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="tools_search_result_editor_contextmenu_schemabrowser_mrd_equality">
+ <title>
+ Open Schema Browser -> Equality Matching Rule Definition
+ </title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/mrd_equality.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Opens the
+ <link linkend="tools_schema_browser_mrd">
+ Matching Rule page
+ </link>
+ in
+ <link linkend="tools_schema_browser">
+ Schema Browser
+ </link>
+ and selects the equality matching rule definiton
+ of the currently selected attribute.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enabled: If an attribute is selected, the
+ attribute provides an equality matching rule and
+ the schema contains this matching rule.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="tools_search_result_editor_contextmenu_schemabrowser_mrd_substring">
+ <title>
+ Open Schema Browser -> Substring Matching Rule Definition
+ </title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/mrd_substring.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Opens the
+ <link linkend="tools_schema_browser_mrd">
+ Matching Rule page
+ </link>
+ in
+ <link linkend="tools_schema_browser">
+ Schema Browser
+ </link>
+ and selects the substring matching rule
+ definiton of the currently selected attribute.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enabled:If an attribute is selected, the
+ attribute provides a substring matching rule and
+ the schema contains this matching rule.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="tools_search_result_editor_contextmenu_schemabrowser_mrd_ordering">
+ <title>
+ Open Schema Browser -> Ordering Matching Rule Definition
+ </title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/mrd_ordering.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Opens the
+ <link linkend="tools_schema_browser_mrd">
+ Matching Rule page
+ </link>
+ in
+ <link linkend="tools_schema_browser">
+ Schema Browser
+ </link>
+ and selects the ordering matching rule definiton
+ of the currently selected attribute.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enabled: If an attribute is selected, the
+ attribute provides an ordering matching rule and
+ the schema contains this matching rule.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="tools_search_result_editor_contextmenu_schemabrowser_lsd">
+ <title>Open Schema Browser -> Syntax Definition</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/lsd.gif"
+ format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Opens the
+ <link linkend="tools_schema_browser_lsd">
+ Syntax page
+ </link>
+ in
+ <link linkend="tools_schema_browser">
+ Schema Browser
+ </link>
+ and selects the syntax definiton of the
+ currently selected attribute.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enabled: If an attribute is selected, the
+ attribute provides an syntax and the schema
+ contains this syntax.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_search_result_edior_contextmenu_copy">
+ <title>Copy Values</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/copy.gif"
+ format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Copies the values of the selected
+ attribute. The values are copied to clipboard in
+ an internal format so they could be pasted to
+ another entry even in the entry editor.
+ Additional they are copied to the system
+ clipboard as string so they could be pasted in
+ other applications. New-line is used as value
+ separator. Binary values are copied BASE-64
+ encoded.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Shortcut:
+ <shortcut>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>C</keycap>
+ </keycombo>
+ </shortcut>
+ or
+ <shortcut>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>Insert</keycap>
+ </keycombo>
+ </shortcut>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_search_result_editor_contextmenu_paste">
+ <title>TODO: Paste Values</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/paste.gif"
+ format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Pasted the previously copied values
+ to the selected attribute. Each value is copied
+ separately, when an error occurs while adding
+ the value the paste operation will continue with
+ the next value.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enabled: If the system clipboard contains
+ values.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Shortcut:
+ <shortcut>
+ <keycombo>
+ <keycap>Ctrl</keycap>
+ <keycap>V</keycap>
+ </keycombo>
+ </shortcut>
+ or
+ <shortcut>
+ <keycombo>
+ <keycap>Shift</keycap>
+ <keycap>Insert</keycap>
+ </keycombo>
+ </shortcut>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_search_result_editor_contextmenu_delete">
+ <title>Delete</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/delete.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Deletes the selected attribute.
+ Note that the following attributes aren't
+ deleteable:
+ <itemizedlist>
+ <listitem>objectClasses</listitem>
+ <listitem>RDN attributes</listitem>
+ <listitem>Must attributes</listitem>
+ <listitem>Operational attributes</listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enabled: If an attributes is selected and this
+ is deletable.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Shortcut:
+ <shortcut>
+ <keycap>Delete</keycap>
+ </shortcut>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="tools_search_result_editor_contextmenu_advanced_copydn">
+ <title>Advanced -> Copy DN</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/copy_dn.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Copies the distinguished name of
+ the current search result (e.g. cn=John
+ Fowler,ou=People,o=JNDITutorial)
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+ <simplesect
+ id="tools_search_result_editor_contextmenu_advanced_copyurl">
+ <title>Advanced -> Copy URL</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/copy_url.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Copies the URL of the current
+ search result (e.g. ldap://localhost:389/cn=John
+ Fowler,ou=People,o=JNDITutorial)
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="tools_search_result_editor_contextmenu_advanced_copyattribute">
+ <title>Advanced -> Copy Attribute Description</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/copy_att.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Copies the attribute description of the selected
+ attribute as string to the system clipboard.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="tools_search_result_editor_contextmenu_advanced_copyutf8">
+ <title>Advanced -> Copy Values (UTF-8)</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/copy_raw.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Copies the selected values UTF-8 encoded to the
+ system clipboard.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="tools_search_result_editor_contextmenu_advanced_copybase64">
+ <title>Advanced -> Copy Values (BASE-64)</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/copy_base64.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Copies the selected values BASE-64 encoded to
+ the system clipboard.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="tools_search_result_editor_contextmenu_advanced_copyhex">
+ <title>Advanced -> Copy Values (HEX)</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/copy_hex.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Copies the selected values HEX encoded to the
+ system clipboard.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="tools_search_result_editor_contextmenu_advanced_copyldif">
+ <title>Advanced -> Copy Name-Value-Pairs as LDIF</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/copy_ldif.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Copies the selected attribute in LDIF format to
+ the system clipboard.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="tools_search_result_editor_contextmenu_advanced_copyfilter">
+ <title>Advanced -> Copy Search Filter</title>
+ <para>
+ Builds search filters from the selected attribute. There are
+ four options:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Default
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/filter_equals.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Copies the selected
+ attribute as LDAP search filter
+ (attribute=value).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enabled: If a singlevalued attribute
+ is selected.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ NOT
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/filter_not.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Copies the selected
+ attribute as LDAP NOT search filter
+ (!(attribute=value)).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enabled: If a singlevalued value is
+ selected.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ AND
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/filter_and.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Copies the selected
+ attribute as LDAP AND search filter
+ (&(attribute1=value1)...(attributeN=valueN)).
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ OR
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/filter_or.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Description: Copies the selected
+ attribute as LDAP OR search filter
+ (|(attribute1=value1)...(attributeN=valueN)).
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_search_result_editor_contextmenu_editvalue">
+ <title>Edit Value</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Edits the selected attribute using the default
+ value editor. To change the default value editor
+ see
+ <link linkend="preferences_value_editors">
+ Value Provider preferences
+ </link>
+ .
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enabled: If an attribute is selected and this is
+ modifyable.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Shortcut:
+ <shortcut>
+ <keycap>F7</keycap>
+ </shortcut>
+ or
+ <shortcut>
+ <keycap>Enter</keycap>
+ </shortcut>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="tools_search_result_editor_contextmenu_editvaluewith">
+ <title>Edit Value With</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Depending on the selected attribute there could
+ be alternate value editors. To edit the selected
+ attribute with another value editor choose one
+ of the listed editors.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Enabled: If an attribute is selected, this is
+ empty or singevalued and this is modifyable.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_search_result_editor_contextmenu_reload">
+ <title>Search Again</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Icon:
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/refresh.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </para>
+ </listitem>
+ <listitem>
+ <para>Performs the search again.</para>
+ </listitem>
+ <listitem>
+ <para>
+ Shortcut:
+ <shortcut>
+ <keycap>F5</keycap>
+ </shortcut>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect
+ id="tools_search_result_editor_contextmenu_properties">
+ <title>Properties</title>
+ <para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ Description: Opens the Properties dialog with
+ the
+ <link linkend="tools_attribute_properties">
+ attribute properties page
+ </link>
+ or
+ <link linkend="tools_entry_properties">
+ entry properties page
+ </link>
+ .
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Shortcut:
+ <keycombo>
+ <keycap>Alt</keycap>
+ <keycap>Enter</keycap>
+ </keycombo>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+</section>
+
Added: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.23_tools_search_result_editor.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.23_tools_search_result_editor.xml?view=auto&rev=498853
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.23_tools_search_result_editor.xml (added)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.23_tools_search_result_editor.xml Mon Jan 22 15:39:53 2007
@@ -0,0 +1,14 @@
+<section id="tools_search_result_editor">
+ <title>Search Result editor</title>
+ <para>
+ The Search Result editor is used to view and edit search
+ results. Although it is placed in the editor area there is only
+ a single instance of the Search Result editor.
+ </para>
+
+ &tools_search_result_editor_overview;
+ &tools_search_result_editor_features;
+ &tools_search_result_editor_contextmenu;
+
+</section>
+
Added: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.24_tools_schema_browser.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.24_tools_schema_browser.xml?view=auto&rev=498853
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.24_tools_schema_browser.xml (added)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.24_tools_schema_browser.xml Mon Jan 22 15:39:53 2007
@@ -0,0 +1,465 @@
+<section id="tools_schema_browser">
+ <title>Schema Browser</title>
+ <para>
+ With the Schema Browser you can browse the schema with its
+ schema elements like object classes, attribute types, matching
+ rules and syntaxes. It is placed in the editor area.
+ </para>
+
+ <section id="tools_schema_browser_overview">
+ <title>Overview</title>
+
+ <para>
+ This section describes general aspects of the Schema
+ Browser.
+ </para>
+
+ <simplesect id="tools_schema_browser_screenshot">
+ <title>Example screenshot</title>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_schema_browser_1.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_schema_browser_layout">
+ <title>Layout</title>
+ <para>
+ The header of the Schema Browser contains the title and
+ the toolbar. The title shows the connection of the
+ currently displayed schema.
+ </para>
+ <para>
+ The Schema Browser consists of five pages:
+ <itemizedlist>
+ <listitem>
+ <para>
+ <link linkend="tools_schema_browser_ocd">
+ Object Classes page
+ </link>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="tools_schema_browser_atd">
+ Attribute Type page
+ </link>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="tools_schema_browser_lsd">
+ LDAP Syntaxes page
+ </link>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="tools_schema_browser_mrd">
+ Matching Rules page
+ </link>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="tools_schema_browser_mru">
+ Matching Rule Use page
+ </link>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ Each page has a master-detail layout. The left part of a
+ page shows a list of all schema elements (like object
+ class names or attribute types). To search a schema
+ element you can filter the list by typing the name of
+ the schema element into the filter input field. When
+ selecting one schema element the right part of the page
+ shows the details.
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_schema_browser_navigation">
+ <title>Navigation</title>
+ <para>
+ In the detail section references to other schema
+ elements are displayed as hyperlinks. Click to the
+ hyperlink to jump to the target schema element.
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_schema_browser_toolbar">
+ <title>Toolbar</title>
+ <para>
+ The toolbar contains the following items:
+ <informaltable frame="all">
+ <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/defaultschema.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>Show Default Schema</entry>
+ <entry>
+ Shows the default schema instead of
+ the schema of the currently selected
+ connection.
+ </entry>
+ <entry></entry>
+ </row>
+ <row>
+ <entry>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/refresh.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ </guiicon>
+ </entry>
+ <entry>Reload Schema</entry>
+ <entry>
+ Reloads the schema of the currently
+ selected connection.
+ </entry>
+ <entry></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </simplesect>
+ </section>
+
+ <section id="tools_schema_browser_ocd">
+ <title>Object Classes</title>
+ <para>
+ The Object Classes page shows the object classes defined in
+ schema.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_schema_browser_2.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ The left part of the page lists the available object
+ classes.
+ </para>
+ <para>
+ The right part of the page shows the details of the selected
+ object class:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Details: Shows the OID, names, description and
+ kind of the object class.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ MUST Attributes: Shows all MUST attributes, even
+ those inherited from superclasses.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ MAY Attributes: Shows all MAY attributes, even
+ those inherited from superclasses.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Superclasses: Shows the object classes this
+ object class is directly derived from (in other
+ words the parents).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Subclasses: Shows the object classes derived
+ from this object class (in other words the
+ children).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Raw Schema Definition: Shows the raw value of
+ the object class definition as returned from
+ server.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+
+ <section id="tools_schema_browser_atd">
+ <title>Attribute Types</title>
+ <para>
+ The Attribute Types page shows the attribute types defined
+ in schema.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_schema_browser_3.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ The left part of the page lists the available attribute
+ types.
+ </para>
+ <para>
+ The right part of the page shows the details of the selected
+ attribute type:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Details: Shows the OID, names, description and
+ usage of the attribute type.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Flags: Shows if the attribute type is
+ single-valued, read-only and/or collective.
+ Non-matching flags are greyed-out.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Syntax: Shows the syntax OID and description and
+ optional a length of the attribute type.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Matching Rules: Shows the equality, substring
+ and ordering matching rules of the attribute
+ type.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Other Matching Rules: Shows additional matching
+ rules applicable to the attribute type.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Used as MUST: Shows object classed where this
+ attribute type is used as MUST.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Used as MAY: Shows object classed where this
+ attribute type is used as MAY.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Supertype: Shows the attribute type where this
+ attribute is derived from (in other words the
+ parent).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Subtypes: Shows attribute types derived from
+ this attribute types (in other words the
+ children).
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Raw Schema Definition: Shows the raw value of
+ the attribute type definition as returned from
+ server.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+
+ <section id="tools_schema_browser_lsd">
+ <title>Syntaxes</title>
+ <para>
+ The Syntaxes page shows the syntaxes defined in schema.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_schema_browser_5.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ The left part of the page lists the available syntaxes.
+ </para>
+ <para>
+ The right part of the page shows the details of the selected
+ syntax:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Details: Shows the OID description of the
+ syntax.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Used from: Shows attribute types using this
+ syntax.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Raw Schema Definition: Shows the raw value of
+ the syntax definition as returned from server.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+
+ <section id="tools_schema_browser_mrd">
+ <title>Matching Rules</title>
+ <para>
+ The Matching Rules page shows the matching rules defined in
+ schema.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_schema_browser_4.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ The left part of the page lists the available matching
+ rules.
+ </para>
+ <para>
+ The right part of the page shows the details of the selected
+ matching rule:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Details: Shows the OID, name and description of
+ the matching rule.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Syntax: Shows the syntax OID and description of
+ the matching rule.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Used from: Shows attribute types using this
+ matching rule.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Raw Schema Definition: Shows the raw value of
+ the matching rule definition as returned from
+ server.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+
+ <section id="tools_schema_browser_mru">
+ <title>Matching Rule Use</title>
+ <para>
+ The Matching Rule Use page shows the matching rule uses
+ defined in schema.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_schema_browser_6.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ The left part of the page lists the available matching rule
+ use descriptions.
+ </para>
+ <para>
+ The right part of the page shows the details of the selected
+ matching rule use:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Details: Shows the OID, namees and description
+ of the matching rules.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Applies: Shows attribute types this matching
+ rule applies to.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Raw Schema Definition: Shows the raw value of
+ the matching rule use definition as returned
+ from server.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+
+</section>
\ No newline at end of file
Added: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.25_tools_modification_logs_view.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.25_tools_modification_logs_view.xml?view=auto&rev=498853
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.25_tools_modification_logs_view.xml (added)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.25_tools_modification_logs_view.xml Mon Jan 22 15:39:53 2007
@@ -0,0 +1,121 @@
+<section id="tools_modification_logs_view">
+ <title>Modification Logs view</title>
+ <para>
+ The Modification Logs view shows all sucessful and failed modifications.
+ </para>
+
+ <simplesect id="tools_modification_logs_view_concept">
+ <title>Concept</title>
+ <para>
+ All modify operations are logged to a logfile in LDIF format. Additionally
+ the result (OK or ERROR) is prepended as LDIF comment to every log record.
+ </para>
+ <para>
+ Example log of a sucessfully performed modification:
+ <code language="LDIF">
+ <sbr />
+ #!RESULT OK
+ <sbr />
+ #!CONNECTION ldap://localhost:389
+ <sbr />
+ #!DATE 2006-11-04T21:32:40.134
+ <sbr />
+ dn: cn=Ted Geisel,ou=People,o=JNDITutorial
+ <sbr />
+ changetype: modify
+ <sbr />
+ add: mail
+ <sbr />
+ mail: Ted.Geisel@JNDITutorial.com
+ <sbr />
+ -
+ <sbr />
+ </code>
+
+ </para>
+ <para>
+ Example log of a failed modification:
+ <code language="LDIF">
+ <sbr />
+ #!RESULT ERROR
+ <sbr />
+ #!CONNECTION ldap://localhost:389
+ <sbr />
+ #!DATE 2006-11-04T21:33:05.739
+ <sbr />
+ #!ERROR [LDAP: error code 20 - modify/add: mail: value #0 already exists]
+ <sbr />
+ dn: cn=Ted Geisel,ou=People,o=JNDITutorial
+ <sbr />
+ changetype: modify
+ <sbr />
+ add: mail
+ <sbr />
+ mail: Ted.Geisel@JNDITutorial.com
+ <sbr />
+ -
+ <sbr />
+ </code>
+ </para>
+ <para>
+ The modification logging mechanism works with logfile rotation.
+ It uses 10 logfiles each with 100KB per connection.
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_modification_logs_view_screenshot">
+ <title>Example screenshot</title>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_modification_logs_1.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_modification_logs_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/refresh.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
+ <entry>Refresh</entry>
+ <entry>Reloads the current modification logfile.</entry>
+ </row>
+ <row>
+ <entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/previous.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
+ <entry>Older</entry>
+ <entry>Loads an older modification logfile.</entry>
+ </row>
+ <row>
+ <entry><guiicon><inlinemediaobject><imageobject><imagedata fileref="icons/next.gif" format="GIF"/></imageobject></inlinemediaobject></guiicon></entry>
+ <entry>Newer</entry>
+ <entry>Loads a newer modification logfile.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </simplesect>
+
+ <simplesect id="tools_modification_logs_view_rotation">
+ </simplesect>
+
+<!--
+ Comment format, rotation
+ -->
+</section>
\ No newline at end of file
Added: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.26_tools_progress_view.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.26_tools_progress_view.xml?view=auto&rev=498853
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.26_tools_progress_view.xml (added)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.26_tools_progress_view.xml Mon Jan 22 15:39:53 2007
@@ -0,0 +1,21 @@
+<section id="tools_progress_view">
+ <title>Progress view</title>
+ <para>Long-running operations, especially every access to directories,
+ are executed in background. The Progress view shows such pending
+ operations.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_progress_view_1.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ To cancel a long-running operation press the stop button.
+ </para>
+
+</section>
\ No newline at end of file
Added: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.27_tools_ldif_editor.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.27_tools_ldif_editor.xml?view=auto&rev=498853
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.27_tools_ldif_editor.xml (added)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.27_tools_ldif_editor.xml Mon Jan 22 15:39:53 2007
@@ -0,0 +1,29 @@
+<section id="tools_ldif_editor">
+ <title>LDIF editor</title>
+ <para>TODO..</para>
+ <para>
+ <itemizedlist>
+ <listitem>Syntax Coloring</listitem>
+ <listitem>Content Assistent</listitem>
+ <listitem>Templates</listitem>
+ <listitem>Formatting</listitem>
+ <listitem>Error Annotations</listitem>
+ <listitem>BASE-64 Tooltip</listitem>
+ <listitem>Edit Attribute Descripton</listitem>
+ <listitem>Edit Value / Value Editors</listitem>
+ <listitem>Edit Record / LDIF Entry Editor</listitem>
+ <listitem>Folding</listitem>
+ <listitem>Execute LDIF</listitem>
+ <listitem>Outline</listitem>
+
+
+ </itemizedlist>
+ </para>
+
+ <!--
+ Outline, select connection + execute, content vs.
+ modify, content assist, templates, errors and warnings,
+ perferences, folding, context menu (edit attribute,
+ value, record), formatting, UTF-8/BASE64
+ -->
+</section>
\ No newline at end of file
Added: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.40_tools_newconnection_wizard.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.40_tools_newconnection_wizard.xml?view=auto&rev=498853
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.40_tools_newconnection_wizard.xml (added)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.40_tools_newconnection_wizard.xml Mon Jan 22 15:39:53 2007
@@ -0,0 +1,372 @@
+<section id="tools_newconnection_wizard">
+ <title>New Connection wizard</title>
+ <para>
+ This wizard helps you to create a new connection to a LDAP
+ directory.
+ </para>
+
+ <para>
+ To start the wizard choose one of the following options:
+ <itemizedlist>
+ <listitem>
+ <para>
+ In the Connections view select the
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
+ fileref="icons/connection_add.gif" format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ <emphasis role="strong">New Connection...</emphasis>
+ button or select
+ <emphasis role="strong">New Connection...</emphasis>
+ from the context menu.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In the Workbench window's toolbar, activate the
+ drop-down menu on the New Wizard button and select
+ <emphasis role="strong">LDAP Connection</emphasis>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In the Workbench menu bar select
+ <emphasis role="strong">
+ File > New > LDAP Connection
+ </emphasis>
+ .
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ The creation of a new LDAP connection is a tree-step process:
+ <orderedlist numeration="arabic">
+ <listitem>
+ <para>
+ <link linkend="tools_newconnection_wizard_1">
+ Define network parameters.
+ </link>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="tools_newconnection_wizard_2">
+ Define authentication parameters.
+ </link>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="tools_newconnection_wizard_3">
+ Define additional connection parameters
+ (optional).
+ </link>
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+
+ <simplesect id="tools_newconnection_wizard_1">
+ <title>Page 1</title>
+ <para>
+ The first page allows you to enter a connnection name and
+ the network parameters.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_newconnection_wizard_1.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ <informaltable frame="all">
+ <tgroup cols="3">
+ <colspec colname="Option" />
+ <colspec colname="Description" />
+ <colspec colname="Default" />
+ <thead>
+ <row>
+ <entry>Option</entry>
+ <entry>Description</entry>
+ <entry>Default</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Connection name</entry>
+ <entry>
+ The name of the connection. In the
+ Connections view the connection is
+ listed with this name. The name must be
+ unique.
+ </entry>
+ <entry>empty</entry>
+ </row>
+ <row>
+ <entry>Hostname</entry>
+ <entry>
+ The hostname or IP address of the LDAP
+ server. A history of recently used
+ hostnames is available through the
+ drop-down list.
+ </entry>
+ <entry>empty</entry>
+ </row>
+ <row>
+ <entry>Port</entry>
+ <entry>
+ The port of the LDAP server. The default
+ port for non-encyrpted connections is
+ 389. The default port for ldaps://
+ connections is 636. A history of
+ recently used ports is available through
+ the drop-down list.
+ </entry>
+ <entry>389</entry>
+ </row>
+ <row>
+ <entry>Encryption method</entry>
+ <entry>
+ The encryption to use. Possible values
+ are 'No encrypton', 'ldaps://' and
+ 'StartTLS extension'. Pay attention for
+ the warning: The current version doesn't
+ support certificate validation!
+ </entry>
+ <entry>No encryption</entry>
+ </row>
+ <row>
+ <entry>Check network parameter</entry>
+ <entry>
+ Use this function if you want to attempt
+ a connection to the host upon completion
+ of the wizard to validate that the
+ entered information is correct.
+ </entry>
+ <entry>-</entry>
+ </row>
+ <row>
+ <entry>Open connection on finish</entry>
+ <entry>
+ If checked the connection is opened when
+ finishing the wizard.
+ </entry>
+ <entry>checked</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_newconnection_wizard_2">
+ <title>Page 2</title>
+ <para>
+ On the second page you could specify the authentication
+ parameters.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_newconnection_wizard_2.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ <informaltable frame="all">
+ <tgroup cols="3">
+ <colspec colname="Option" />
+ <colspec colname="Description" />
+ <colspec colname="Default" />
+ <thead>
+ <row>
+ <entry>Option</entry>
+ <entry>Description</entry>
+ <entry>Default</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Anonymous Authentication</entry>
+ <entry>
+ Uses anonymous authentication, no
+ authentication parameters required.
+ </entry>
+ <entry>not checked</entry>
+ </row>
+ <row>
+ <entry>Simple Authentication</entry>
+ <entry>
+ Uses simple authentication, requires
+ authenticaton parameters.
+ </entry>
+ <entry>checked</entry>
+ </row>
+ <row>
+ <entry>Bind DN</entry>
+ <entry>
+ The distinguished name used to bind.
+ Previously entered DNs could be selected
+ from drop-down list.
+ </entry>
+ <entry>empty</entry>
+ </row>
+ <row>
+ <entry>Bind Password</entry>
+ <entry>The password used to bind.</entry>
+ <entry>empty</entry>
+ </row>
+ <row>
+ <entry>Save password</entry>
+ <entry>
+ If checked the password will be saved in
+ configuration. If not checked you have
+ to enter the password whenever you
+ connect to the server. Warning: The
+ password is saved as plain text!
+ </entry>
+ <entry>checked</entry>
+ </row>
+ <row>
+ <entry>Check Authentication</entry>
+ <entry>
+ Use this function if you want to attempt
+ a connection plus a bind to the host
+ upon completion of the wizard to
+ validate that the entered information is
+ correct.
+ </entry>
+ <entry>-</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_newconnection_wizard_3">
+ <title>Page 3</title>
+ <para>
+ On the third page you could enter additional connection
+ parameters.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_newconnection_wizard_3.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ <informaltable frame="all">
+ <tgroup cols="3">
+ <colspec colname="Option" />
+ <colspec colname="Description" />
+ <colspec colname="Default" />
+ <thead>
+ <row>
+ <entry>Option</entry>
+ <entry>Description</entry>
+ <entry>Default</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Get base DNs from Root DSE</entry>
+ <entry>
+ If checked the base DNs are fetched from
+ namingContexts attribute of the Root
+ DSE.
+ </entry>
+ <entry>checked</entry>
+ </row>
+ <row>
+ <entry>Fetch Base DNs</entry>
+ <entry>
+ Use this function to get the
+ namingContext values from the root DSE.
+ The returned values will appear in the
+ 'Base DN' drop-down list.
+ </entry>
+ <entry>-</entry>
+ </row>
+ <row>
+ <entry>Base DN</entry>
+ <entry>
+ The base DN to use. You may enter a DN
+ manually or you may select one from the
+ drop-down list. This field is only
+ enabled if the option 'Get base DNs from
+ root DSE' is off.
+ </entry>
+ <entry>empty</entry>
+ </row>
+ <row>
+ <entry>Count Limit</entry>
+ <entry>
+ Maximum number of entries returned from
+ server when browsing the directory, it
+ is also used as default value when
+ searching the directory. A value of 0
+ means no count limit. Note that this
+ value is a client-side value, its
+ possible that also a server-side limit
+ is used.
+ </entry>
+ <entry>1000</entry>
+ </row>
+ <row>
+ <entry>Time Limit</entry>
+ <entry>
+ The maximum time in milliseconds the
+ server searches for results. This is
+ used as default value when browsing or
+ searching the directory. A value of 0
+ means no limit. Note that this value is
+ a client-side value, its possible that
+ also a server-side limit is used.
+ </entry>
+ <entry>0</entry>
+ </row>
+ <row>
+ <entry>Alias Dereferencing</entry>
+ <entry>
+ Specifies whether aliases should be
+ derefenced while finding the search base
+ entry or when performing the search or
+ both.
+ </entry>
+ <entry>Both finding and searching</entry>
+ </row>
+ <row>
+ <entry>Referrals Handling</entry>
+ <entry>
+ Specifies the referral handling. Ignore
+ means that referrals returned from
+ server are ignored, Follow means that
+ the LDAP Browser will follow referrals
+ returned from server.
+ </entry>
+ <entry>Follow</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </simplesect>
+
+</section>
\ No newline at end of file
Added: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.41_tools_newentry_wizard.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.41_tools_newentry_wizard.xml?view=auto&rev=498853
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.41_tools_newentry_wizard.xml (added)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.41_tools_newentry_wizard.xml Mon Jan 22 15:39:53 2007
@@ -0,0 +1,272 @@
+<section id="tools_newentry_wizard">
+ <title>New Entry wizard</title>
+ <para>This wizard helps you to create a new entry.</para>
+
+ <para>
+ To start the wizard choose one of the following options:
+ <itemizedlist>
+ <listitem>
+ <para>
+ In the LDAP Browser view select an entry or search
+ result or bookmark. Then choose
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/entry_add.gif"
+ format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ <emphasis role="strong">New Entry...</emphasis>
+ from context menu.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In the Workbench window's toolbar, activate the
+ drop-down menu on the New Wizard button and select
+ <emphasis role="strong">LDAP Entry</emphasis>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ In the Workbench menu bar select
+ <emphasis role="strong">
+ File > New > LDAP Entry
+ </emphasis>
+ .
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ The creation of a new LDAP entry is a four-step process:
+ <orderedlist numeration="arabic">
+ <listitem>
+ <para>
+ <link linkend="tools_newentry_wizard_1">
+ Select entry creation method.
+ </link>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="tools_newentry_wizard_2">
+ Specify object classes of the new entry.
+ </link>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="tools_newentry_wizard_3">
+ Specifiy the distinguished name of the new
+ entry.
+ </link>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <link linkend="tools_newentry_wizard_4">
+ Enter attributes and values of the new entry.
+ </link>
+ </para>
+ </listitem>
+ </orderedlist>
+ </para>
+
+ <simplesect id="tools_newentry_wizard_1">
+ <title>Page 1</title>
+ <para>First you have to select the entry creation method.</para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_newentry_wizard_1.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ With the option
+ <emphasis role="strong">Create entry from scratch</emphasis>
+ you could create a the new entry from scratch. All object
+ classes and attributes have to be specified in the wizard.
+ </para>
+ <para>
+ The option
+ <emphasis role="strong">
+ Use existing entry as template
+ </emphasis>
+ allows you to use an existing entry with its object classes
+ and attributes as template. The entry used as template could
+ be specified in the input field:
+ <itemizedlist>
+ <listitem>
+ <para>
+ By default the DN of entry that was selected
+ when the wizard has been started is used as
+ template entry.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ You could manually edit the DN of the templayte
+ entry.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ You could choose a previously used DN from
+ drop-down list.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ By clicking
+ <emphasis role="strong">Browse....</emphasis>
+ you could open a dialog to select the DN of the
+ template entry.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_newentry_wizard_2">
+ <title>Page 2</title>
+ <para>
+ On the second page you have to choose the object classes of
+ the new entry.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_newentry_wizard_2.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ The list
+ <emphasis role="strong">Available object classes</emphasis>
+ on the left side lists the object classes provided from
+ schema of the current connection. The list
+ <emphasis role="strong">Selected object classes</emphasis>
+ lists the object classes of the new entry. To add object
+ classed to the "selected" list select some in the
+ "available" list and click the
+ <emphasis role="strong">Add</emphasis>
+ button. You could also double-click an object class in the
+ "available" list. To remove object classed from the
+ "selected" list select some in the "selected" list and click
+ the
+ <emphasis role="strong">Remove</emphasis>
+ button. You could also double-click an object class in the
+ "selected" list.
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_newentry_wizard_3">
+ <title>Page 3</title>
+ <para>
+ On the third page you have to define the distinguished name
+ of the new entry.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_newentry_wizard_3.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ The parent of the new entry could be specified in the input
+ field:
+ <itemizedlist>
+ <listitem>
+ <para>
+ If you choosed the "from scratch" method the DN
+ of entry that was selected when the wizard has
+ been started is used by default. If you choosed
+ the "template" method the parent of the template
+ entry is used by default.
+ </para>
+ </listitem>
+ <listitem>
+ <para>You could manually edit the parent DN.</para>
+ </listitem>
+ <listitem>
+ <para>
+ You could choose a previously used DN from
+ drop-down list.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ By clicking
+ <emphasis role="strong">Browse....</emphasis>
+ you could open a dialog to select the parent DN.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ To specify the RDN select an attribute from the drop-down
+ list and enter the value. If you choosed the "template"
+ method the RDN is preset with the RDN of the template entry.
+ The wizard also support multivalued RDNs. With the
+ <emphasis role="strong">+</emphasis>
+ and
+ <emphasis role="strong">-</emphasis>
+ buttons you can add and remove name-value pairs.
+ </para>
+ <para>The DN preview field shows a preview of the DN.</para>
+ <para>
+ When clicking to
+ <emphasis role="strong">Next</emphasis>
+ the wizard checks if an entry with the specified DN already
+ exists. In that case you have to change the DN of the new
+ entry.
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_newentry_wizard_4">
+ <title>Page 4</title>
+ <para>
+ On the fourth page you have to define the attributes of the
+ new entry.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_newentry_wizard_4.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ The layout and features are similar to the Entry editor. You
+ could add, edit or delete attributes and values.
+ </para>
+ <para>
+ If you have choosed the "template" method all attributes of
+ the template entry are already filled in the new entry.
+ Otherwise only the selected object classes and the RDN
+ attribute are filled.
+ </para>
+ <para>
+ As soon as all MUST attributes are filled the
+ <emphasis role="strong">Finish</emphasis>
+ button is activated. When clicking the button the new entry
+ will be created in directory.
+ </para>
+ </simplesect>
+
+</section>
\ No newline at end of file
Added: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.42_tools_attribute_wizard.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.42_tools_attribute_wizard.xml?view=auto&rev=498853
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.42_tools_attribute_wizard.xml (added)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.42_tools_attribute_wizard.xml Mon Jan 22 15:39:53 2007
@@ -0,0 +1,182 @@
+<section id="tools_attribute_wizard">
+ <title>Attribute wizard</title>
+ <para>
+ The Attribute wizard is used to create an attribute or to edit
+ the attribute description of an existing attribute.
+ </para>
+ <para>
+ To create a new attribute select the
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="icons/attribute_add.gif"
+ format="GIF" />
+ </imageobject>
+ </inlinemediaobject>
+ <emphasis role="strong">New Attribute...</emphasis>
+ button in the Entry editor or select
+ <emphasis role="strong">New Attribute...</emphasis>
+ from the Entry editor's context menu.
+ </para>
+ <para>
+ To edit the attribute description select an attribute in the
+ Entry editor and select
+ <emphasis role="strong">Edit Attribute Description</emphasis>
+ from context menu or use the
+ <shortcut>
+ <keycap>F6</keycap>
+ </shortcut>
+ shortcut.
+ </para>
+
+ <simplesect id="tools_attribute_wizard_1">
+ <title>Page 1</title>
+ <para>
+ On the first page you have to enter the attribute type.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_attribute_wizard_1.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ <informaltable frame="all">
+ <tgroup cols="3">
+ <colspec colname="Option" />
+ <colspec colname="Description" />
+ <colspec colname="Default" />
+ <thead>
+ <row>
+ <entry>Option</entry>
+ <entry>Description</entry>
+ <entry>Default</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Attribute type</entry>
+ <entry>
+ The attribute type. Enter the attribute
+ type into the input field or select one
+ from drop-down-list.
+ </entry>
+ <entry>
+ Empty in New Attribute wizard, filled in
+ Edit Attribute Description wizard.
+ </entry>
+ </row>
+ <row>
+ <entry>
+ Show subschema attributes only
+ </entry>
+ <entry>
+ If checked the drop-down list contains
+ only attributes suitable to the entry's
+ subschema.
+ </entry>
+ <entry>Checked</entry>
+ </row>
+ <row>
+ <entry>Hide existing attributes</entry>
+ <entry>
+ If checked the drop-down list contains
+ only attributes not yet assigned to the
+ entry.
+ </entry>
+ <entry>
+ Checked in New Attribute wizard,
+ unchecked in Edit Attribute Description
+ wizard.
+ </entry>
+ </row>
+ <row>
+ <entry>Preview</entry>
+ <entry>
+ Shows a preview of the attribute
+ description.
+ </entry>
+ <entry>-</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </simplesect>
+
+ <simplesect id="tools_attribute_wizard_2">
+ <title>Page 2</title>
+ <para>On the second page you could specify options.</para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata
+ fileref="images/tools_attribute_wizard_2.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ <informaltable frame="all">
+ <tgroup cols="2">
+ <colspec colname="Option" />
+ <colspec colname="Description" />
+ <thead>
+ <row>
+ <entry>Option</entry>
+ <entry>Description</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Language tags</entry>
+ <entry>
+ To provide language-specifc attributes
+ you could use language tags if supported
+ by the directory. Enter a language code
+ and optionally a country code into the
+ input fields or select values from
+ drop-down lists. With the
+ <emphasis role="strong">+</emphasis>
+ and
+ <emphasis role="strong">-</emphasis>
+ buttons you could add and remove tags.
+ </entry>
+ </row>
+ <row>
+ <entry>Other options</entry>
+ <entry>
+ If needed you may enter specific
+ options. With the
+ <emphasis role="strong">+</emphasis>
+ and
+ <emphasis role="strong">-</emphasis>
+ buttons you could add and remove
+ options.
+ </entry>
+ </row>
+ <row>
+ <entry>Binary option</entry>
+ <entry>
+ If checked the binary option is added to
+ attribute description.
+ </entry>
+ </row>
+ <row>
+ <entry>Preview</entry>
+ <entry>
+ Shows a preview of the attribute
+ description.
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </para>
+ </simplesect>
+
+</section>
\ No newline at end of file