Added: directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22.0_tools_entry_editor_overview.xml
URL: http://svn.apache.org/viewvc/directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22.0_tools_entry_editor_overview.xml?rev=592038&view=auto
==============================================================================
--- directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22.0_tools_entry_editor_overview.xml (added)
+++ directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22.0_tools_entry_editor_overview.xml Mon Nov 5 07:16:53 2007
@@ -0,0 +1,432 @@
+
+
+
+
+ Overview
+
+
+ This section describes general aspects of the Entry editor.
+
+
+
+ Example screenshot
+
+
+
+
+
+
+
+
+
+
+
+
+ Layout
+
+ The Entry editor has a two-column layout. The left column
+ contains the attribute descriptions (names), the right
+ column contains the attribute values. Each line represents a
+ name-value pair.
+
+
+ The Entry editor has its own toolbar. The left part displays
+ the distinguished name of the current entry. The right part
+ contains the toolbar icons and menu.
+
+
+
+
+ Fonts and colors
+
+ To distinguish the different attribute classes the Entry
+ editor uses different fonts. By default the following fonts
+ and colors are used:
+
+
+
+
+
+
+
+
+ Attribute class
+ Default font
+ Default color
+ Example
+
+
+
+
+ objectClass attribute
+ bold and italic
+ black
+
+
+
+
+
+
+
+
+
+
+
+ Must attributes
+ bold
+ black
+
+
+
+
+
+
+
+
+
+
+
+ May attributes
+ normal
+ black
+
+
+
+
+
+
+
+
+
+
+
+ Operational attributes
+ italic
+ black
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ These fonts and colors could be changed in the
+
+ Attributes preferences
+
+ .
+
+
+
+
+ Toolbar
+
+ The toolbar contains the following items:
+
+
+
+
+
+
+
+
+ Icon
+ Action
+ Description
+ Shortcut
+
+
+
+
+
+
+
+
+
+
+
+
+
+ New Value
+
+ Adds a new value to the selected
+ attribute and starts the edit mode.
+
+
+
+
+ Ctrl
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ New Attribute...
+
+ Opens the
+
+ New Attribute wizard
+
+ . When finishing the wizard a new
+ attribute is created and the edit mode
+ is started to enter a value.
+
+
+
+
+ Shift
+ Ctrl
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Delete
+ Deletes the selected values.
+
+
+ Delete
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Delete Attributes
+
+ Deletes all values of the selected
+ attributes. Applicable to multi-valued
+ attributes, if you want to delete the
+ complete attribute just select one value
+ use this action.
+
+
+
+
+
+
+
+
+
+
+
+
+ Reload Attributes
+
+ Reloads the attributes of the current
+ entry.
+
+
+
+ F5
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Expand All
+
+ Expands all folded attributes.
+
+
+
+
+
+
+
+
+
+
+
+
+ Collapse All
+
+ Collapses all folded attributes.
+
+
+
+
+
+
+
+
+
+
+
+
+ Show Quick Filter
+
+ Shows/Hides the
+
+ Quick Filter
+
+ .
+
+
+
+
+ Ctrl
+ F
+
+
+
+
+
+
+
+
+
+
+
+ Drop Down Menu
+
+ The drop down menu contains the following items:
+
+
+
+ Sorting...: Opens the
+
+ Sort Dialog
+
+ to set default sorting.
+
+
+
+
+ Show Operational Attributes: If checked the
+ operational attributes (e.g. createTimestampe
+ and modifyTimestamp) are fetched and displayed.
+
+
+
+
+ Show Raw Values: If checked the raw values (as
+ stored in directory) are displayed. By default
+ some attributes have a special display value:
+
+
+ Images: Image format, width, height, and
+ size.
+
+ Binary data: Data size.
+
+ Passwords: Used hash method.
+
+
+ Timestamps: Locale dependent date and
+ time format.
+
+
+
+
+
+
+ Preferences...: Opens the
+
+ Entry editor preferences
+
+ dialog.
+
+
+
+
+
+
+
Propchange: directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22.0_tools_entry_editor_overview.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22.1_tools_entry_editor_features.xml
URL: http://svn.apache.org/viewvc/directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22.1_tools_entry_editor_features.xml?rev=592038&view=auto
==============================================================================
--- directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22.1_tools_entry_editor_features.xml (added)
+++ directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22.1_tools_entry_editor_features.xml Mon Nov 5 07:16:53 2007
@@ -0,0 +1,299 @@
+
+
+ Features
+
+ This section describes the features of the Entry editor.
+
+
+
+ Sorting
+
+ You could sort the displayed attributes by attribute
+ description or value by clicking to the column header. The
+ current sort criteria and direction is indicated by an
+ arrow. The default sorting behaviour could be changed in the
+
+ Sort Dialog
+
+ (
+
+ Toolbar menu ->
+
+
+
+
+
+
+
+ Sorting
+
+ ):
+
+
+
+
+ Sort dialog
+
+ The default sorting behaviour of the entry editor could be
+ changed in this dialog.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Field
+ Description
+ Default
+
+
+
+
+
+ ObjectClass and must attributes first
+
+
+ If enabled, objectClass and must attributes
+ are grouped at the top.
+
+ on
+
+
+ Operational attributes last
+
+ If enabled, operational attributes (e.g.
+ createTimestamp and modifyTimestamp) are
+ grouped at the bottom.
+
+ on
+
+
+ Sort by
+
+ Default sort criteria and order of attribute
+ and values. Select either 'Attribute
+ Description' or 'Value' from the drop-down
+ list as sort critera and select the sort
+ order. Or select 'No sorting' to disable
+ default sorting.
+
+
+ Attribute Description and Ascending
+
+
+
+
+
+
+
+
+ Quick Filter
+
+ If an entry has many attributes and values it is difficult
+ to find a specific attribute. The Quick Filter provides a
+ client-side filter. To show/hide the Quick Filter toggle the
+
+
+
+
+
+
+
+ button or press
+
+
+ Ctrl
+ F
+
+
+ . Enter (even parts of) attribute descriptions or values
+ into the input fields, only matching attributes keep
+ displayed. When hiding the filter is removed.
+
+
+
+
+
+
+
+
+
+
+
+ Visible attributes
+
+ By default all user attributes of an entry are fetched and
+ displayed in the Entry editor. In the
+
+ Entry editor preferences
+
+ it is possible to define which classes of attributes (must,
+ may, operational) are displayed. If you are interested in
+ operational attributes enable the option "Show operational
+ attributes" in Entry editor toolbar menu. Note: When
+ changing these settings please refresh attributes to ensure
+ that the attributes are fetched from directory.
+
+
+
+
+ Folding
+
+ By default attributes with more than 10 values are folded.
+ The attribute is displayed as single line containing the
+ number of values
+
+
+
+
+
+
+
+
+
+ Expand the attribute to make the values visible
+ (double-click works also). To expand/collapse all folded
+ attributes use the
+
+
+
+
+
+
+
+ Collapse All and
+
+
+
+
+
+
+
+ Expand All and buttons from toolbar.
+
+
+
+
+
+
+
+
+
+ You could change this setting in
+
+ Entry editor preferences
+ .
+
+
+
+
+ Locate DN in DIT
+
+ If a value contains a distinguished name the
+
+
+
+
+
+
+
+ Locate DN in DIT
+ action can be used to locate and open the entry in the DIT.
+
+
+
+
+ Query by example
+
+ When selecting attributes these attribute-value-pairs are
+ used to build a search filter, this feature could be used
+ for "query by example".
+
+
+
+ Select example attributes and choose
+ New Search...
+ from context menu. Watch the search filter in
+ the search dialog.
+
+
+
+
+ Select example attributes and choose
+
+ Advanced -> Copy [NOT|AND|OR] Search Filter
+
+ from context menu. This copies the search filter
+ to system clipboard.
+
+
+
+ When building a filter necessary value encoding is supported
+ (*->\2a, (->\28, )->29, \->\5c, NUL->\00).
+
+
+
+
+ Editing
+
+
+ It is possible to add, edit or delete attributes and values of
+ an entry in the Entry editor.
+
+
+ To enter the edit mode using the default value editor select a
+ value and press
+ Enter
+ or
+ F7
+ or double-click the value. 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
+
+ Context Menu -> Edit Value With
+ .
+
+
+ To finish editing press Enter or click to another value 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.
+
+
+
+
\ No newline at end of file
Propchange: directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22.1_tools_entry_editor_features.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22.9_tools_entry_editor_contextmenu.xml
URL: http://svn.apache.org/viewvc/directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22.9_tools_entry_editor_contextmenu.xml?rev=592038&view=auto
==============================================================================
--- directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22.9_tools_entry_editor_contextmenu.xml (added)
+++ directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22.9_tools_entry_editor_contextmenu.xml Mon Nov 5 07:16:53 2007
@@ -0,0 +1,1221 @@
+
+
+ Context Menu
+
+ This section describes the context menu of the Entry Editor.
+
+
+
+ New Attribute...
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Opens the
+
+ New Attribute wizard
+
+ . When finishing the wizard a new attribute is
+ created and the edit mode is started to enter a
+ value.
+
+
+
+
+ Enabled: If attributes or values are selected.
+
+
+
+
+ Shortcut:
+
+
+ Shift
+ Ctrl
+ +
+
+
+
+
+
+
+
+
+
+ New Value
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Adds a new value to the selected
+ attribute and starts the edit mode.
+
+
+
+
+ Enabled: If one attribute or value is selected
+ and the attribute is modifyable and multivalued.
+
+
+
+
+ Shortcut:
+
+
+ Ctrl
+ +
+
+
+
+
+
+
+
+
+
+ New Search...
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Opens the
+
+ Search dialog
+
+ . The selected attributes and values are used to
+ build the search filter (Query by example).
+
+
+
+
+ Enabled: If attributes or values are selected.
+
+
+
+
+ Shortcut:
+
+
+ Ctrl
+ H
+
+
+
+
+
+
+
+
+
+ New Batch Operation...
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Opens the
+
+ Batch Operation wizard
+
+ . If one or multiple DN values are selected
+ these DNs are used as operation objects.
+ Otherwise the selected attributes and values are
+ used to build the search filter (Query by
+ example).
+
+
+
+
+ Enabled: If attributes or values are selected.
+
+
+
+
+
+
+
+ Locate DN in DIT
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Locates the entry of the selected
+ DN in DIT.
+
+
+
+
+ Enabled: If one value is selected and this value
+ is a distinguished name.
+
+
+
+
+ Shortcut:
+
+ F3
+
+
+
+
+
+
+
+
+
+ Open Schema Browser -> Object Class Definition
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Opens the
+
+ Object Class page
+
+ in
+
+ Schema Browser
+
+ and selects the object class definition of the
+ currently selected objectClass value.
+
+
+
+
+ Enabled: If one objectClass value is selected
+ and the schema contains this object class.
+
+
+
+
+
+
+
+ Open Schema Browser -> Attribute Type Definition
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Opens the
+
+ Attribute Type page
+
+ in
+
+ Schema Browser
+
+ and selects the attribute type definiton of the
+ currently selected attribute.
+
+
+
+
+ Enabled: If one attribute or value is selected
+ and the schema contains this attribute type.
+
+
+
+
+
+
+
+
+ Open Schema Browser -> Equality Matching Rule Definition
+
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Opens the
+
+ Matching Rule page
+
+ in
+
+ Schema Browser
+
+ and selects the equality matching rule definiton
+ of the currently selected attribute.
+
+
+
+
+ Enabled: If one attribute or value is selected,
+ the attribute provides an equality matching rule
+ and the schema contains this matching rule.
+
+
+
+
+
+
+
+
+ Open Schema Browser -> Substring Matching Rule Definition
+
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Opens the
+
+ Matching Rule page
+
+ in
+
+ Schema Browser
+
+ and selects the substring matching rule
+ definiton of the currently selected attribute.
+
+
+
+
+ Enabled: If one attribute or value is selected,
+ the attribute provides a substring matching rule
+ and the schema contains this matching rule.
+
+
+
+
+
+
+
+
+ Open Schema Browser -> Ordering Matching Rule Definition
+
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Opens the
+
+ Matching Rule page
+
+ in
+
+ Schema Browser
+
+ and selects the ordering matching rule definiton
+ of the currently selected attribute.
+
+
+
+
+ Enabled: If one attribute or value is selected,
+ the attribute provides an ordering matching rule
+ and the schema contains this matching rule.
+
+
+
+
+
+
+
+ Open Schema Browser -> Syntax Definition
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Opens the
+
+ Syntax page
+
+ in
+
+ Schema Browser
+
+ and selects the syntax definiton of the
+ currently selected attribute.
+
+
+
+
+ Enabled: If one attribute or value is selected,
+ the attribute provides an syntax and the schema
+ contains this syntax.
+
+
+
+
+
+
+
+ Copy Values
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Copies the selected values. The
+ values are copied to clipboard in an internal
+ format so they could be pasted to another entry
+ even in the search result 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.
+
+
+
+
+ Shortcut:
+
+
+ Ctrl
+ C
+
+
+ or
+
+
+ Ctrl
+ Insert
+
+
+
+
+
+
+
+
+
+ Paste Values
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Pasted the previously copied values
+ to the current entry. Each value is copied
+ separately, when an error occurs while adding
+ the value the paste operation will continue with
+ the next value.
+
+
+
+
+ Enabled: If the system clipboard contains
+ values.
+
+
+
+
+ Shortcut:
+
+
+ Ctrl
+ V
+
+
+ or
+
+
+ Shift
+ Insert
+
+
+
+
+
+
+
+
+
+ Delete
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Deletes the selected attributes and
+ values. Note that the following attributes
+ aren't deleteable:
+
+
+ objectClasses which attributes are
+ contained in the entry
+
+ RDN attributes
+
+ The last value of must attributes
+
+ Operational attributes
+
+
+
+
+
+ Enabled: If attributes and values are selected
+ and they are deletable.
+
+
+
+
+ Shortcut:
+
+ Delete
+
+
+
+
+
+
+
+
+ Select All
+
+
+
+
+ Description: Selects all attributes and values.
+
+
+
+
+ Shortcut:
+
+
+ Ctrl
+ A
+
+
+
+
+
+
+
+
+
+ Advanced -> Copy DN
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Copies the distinguished name of
+ the current entry (e.g. cn=John
+ Fowler,ou=People,o=JNDITutorial)
+
+
+
+
+
+
+ Advanced -> Copy URL
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Copies the URL of the current entry
+ (e.g. ldap://localhost:389/cn=John
+ Fowler,ou=People,o=JNDITutorial)
+
+
+
+
+
+
+
+ Advanced -> Copy Attribute Descriptions
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Copies the attribute descriptions of the
+ selected attributes and values as string to the
+ system clipboard.
+
+
+
+
+
+
+
+ Advanced -> Copy Values (UTF-8)
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Copies the selected values UTF-8 encoded to the
+ system clipboard.
+
+
+
+
+
+
+
+ Advanced -> Copy Values (BASE-64)
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Copies the selected values BASE-64 encoded to
+ the system clipboard.
+
+
+
+
+
+
+
+ Advanced -> Copy Values (HEX)
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Copies the selected values HEX encoded to the
+ system clipboard.
+
+
+
+
+
+
+
+ Advanced -> Copy Name-Value-Pairs as LDIF
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Copies the selected attribute and values in LDIF
+ format to the system clipboard.
+
+
+
+
+
+
+
+ Advanced -> Copy Search Filter
+
+ Builds search filters from the selected attributes and
+ values. There are four options:
+
+
+
+ Default
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Copies the selected
+ attribute and value as LDAP search
+ filter (attribute=value).
+
+
+
+
+ Enabled: If one value is selected.
+
+
+
+
+
+
+
+ NOT
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Copies the selected
+ attribute and value as LDAP NOT
+ search filter (!(attribute=value)).
+
+
+
+
+ Enabled: If one value is selected.
+
+
+
+
+
+
+
+ AND
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Copies the selected
+ attributes and values as LDAP AND
+ search filter
+ (&(attribute1=value1)...(attributeN=valueN)).
+
+
+
+
+
+
+
+ OR
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Copies the selected
+ attributes and values as LDAP OR
+ search filter
+ (|(attribute1=value1)...(attributeN=valueN)).
+
+
+
+
+
+
+
+
+
+
+ Advanced -> Delete Attributes
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Description: Deletes all values of the selected
+ attributes. Applicable to multi-valued
+ attributes, if you want to delete the complete
+ attribute just select one value use this action.
+
+
+
+
+ Enabled: If values of multi-valued attributes
+ are selected and these attributes are
+ deleteable.
+
+
+
+
+
+
+
+ Edit Attribute Description
+
+
+
+
+ Description: Opens the
+
+ Edit Attribute wizard
+
+ . When changing the attribute description a add
+ operation and a delete operation is performed.
+ Note that the attribute descriptions of the
+ following attributes aren't editable (analog to
+ delete):
+
+
+ objectClasses which attributes are
+ contained in the entry
+
+ RDN attributes
+
+ The last value of must attributes
+
+ Operational attributes
+
+
+
+
+
+ Enabled: If one attribut or value is selected
+ and the attribute description is editable.
+
+
+
+
+ Shortcut:
+
+ F6
+
+
+
+
+
+
+
+
+ Edit Value
+
+
+
+
+ Edits the selected value using the default value
+ editor. To change the default value editor see
+
+ Value Provider preferences
+
+ .
+
+
+
+
+ Enabled: If one value is selected and this is
+ modifyable.
+
+
+
+
+ Shortcut:
+
+ F7
+
+ or
+
+ Enter
+
+
+
+
+
+
+
+
+ Edit Value With
+
+
+
+
+ Depending on the selected value there could be
+ alternate value editors. To edit the selected
+ value with another value editor choose one of
+ the listed editors.
+
+
+
+
+ Enabled: If one value is selected and this is
+ modifyable.
+
+
+
+
+
+
+
+ Reload Attribute
+
+
+
+
+ Icon:
+
+
+
+
+
+
+
+
+
+
+
+ Reloads the attributes of the current entry.
+
+
+
+
+ Shortcut:
+
+ F5
+
+
+
+
+
+
+
+
+ Properties
+
+
+
+
+ Description: Opens the Properties dialog with
+ the
+
+ Attribute properties page
+
+ or
+
+ Value properties page
+
+ .
+
+
+
+
+ Shortcut:
+
+ Alt
+ Enter
+
+
+
+
+
+
+
+
\ No newline at end of file
Propchange: directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22.9_tools_entry_editor_contextmenu.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22_tools_entry_editor.xml
URL: http://svn.apache.org/viewvc/directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22_tools_entry_editor.xml?rev=592038&view=auto
==============================================================================
--- directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22_tools_entry_editor.xml (added)
+++ directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22_tools_entry_editor.xml Mon Nov 5 07:16:53 2007
@@ -0,0 +1,30 @@
+
+
+ Entry editor
+
+ The Entry editor is used to view and edit the attributes and values of an entry.
+ Although it is placed in the editor area there is only a single instance of the Entry editor.
+
+
+ &tools_entry_editor_overview;
+ &tools_entry_editor_features;
+ &tools_entry_editor_contextmenu;
+
+
Propchange: directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.22_tools_entry_editor.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.23.0_tools_search_result_editor_overview.xml
URL: http://svn.apache.org/viewvc/directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.23.0_tools_search_result_editor_overview.xml?rev=592038&view=auto
==============================================================================
--- directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.23.0_tools_search_result_editor_overview.xml (added)
+++ directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.23.0_tools_search_result_editor_overview.xml Mon Nov 5 07:16:53 2007
@@ -0,0 +1,291 @@
+
+
+ Overview
+
+
+ This section describes general aspects of the Search Result
+ editor.
+
+
+
+ Example screenshot
+
+
+
+
+
+
+
+
+
+
+
+
+ Layout
+
+ 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.
+
+
+ The cells have the following meaning:
+
+
+
+ A value indicates that the entry has such an
+ attribute with exacly one value.
+
+
+
+
+ An empty cell indicates that the entry hasn't
+ such an attribute.
+
+
+
+
+ X values: ... indicates that the entry has
+ multiple values for that attribute.
+
+
+
+
+
+ You can choose whether the DN of each search result is
+ displayed as first column. Toggle
+ Toolbar menu -> Show DN
+ .
+
+
+
+
+ Fonts and Colors
+
+ To distinguish the different attribute classes the Search
+ Result editor uses the same fonts and colos as the
+ Entry editor
+ .
+
+
+
+
+ Toolbar
+
+ The toolbar contains the following items:
+
+
+
+
+
+
+
+
+ Icon
+ Action
+ Description
+ Shortcut
+
+
+
+
+
+
+
+
+
+
+
+
+
+ New Value
+
+ Adds a new value to the selected
+ attribute and starts the edit mode.
+
+
+
+
+ Ctrl
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Delete
+
+ Deletes the selected attribute.
+
+
+
+ Delete
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Refresh
+ Performs the current search.
+
+
+ F5
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Copy Table
+
+ 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
+
+ Text Formats preferences
+
+ .
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Show Quick Filter
+
+ Shows/Hides the
+
+ Quick Filter
+
+ .
+
+
+
+
+ Ctrl
+ F
+
+
+
+
+
+
+
+
+
+
+
+ Drop Down Menu
+
+ The drop down menu contains the following items:
+
+
+
+ Show DN: If checked the distinguished name of
+ each search result is displayed as first column.
+
+
+
+
+ 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.
+
+
+
+
+ Show Raw Values: If checked the raw values (as
+ stored in directory) are displayed. By default
+ some attributes have a special display value:
+
+
+ Images: Image format, width, height, and
+ size.
+
+ Binary data: Data size.
+
+ Passwords: Used hash method.
+
+
+ Timestamps: Locale dependent date and
+ time format.
+
+
+
+
+
+
+ Preferences...: Opens the
+
+ Search Result editor preferences
+
+ dialog.
+
+
+
+
+
+
+
Propchange: directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.23.0_tools_search_result_editor_overview.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.23.1_tools_search_result_editor_features.xml
URL: http://svn.apache.org/viewvc/directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.23.1_tools_search_result_editor_features.xml?rev=592038&view=auto
==============================================================================
--- directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.23.1_tools_search_result_editor_features.xml (added)
+++ directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.23.1_tools_search_result_editor_features.xml Mon Nov 5 07:16:53 2007
@@ -0,0 +1,207 @@
+
+
+ Features
+
+ This section describes the features of the Search Result editor.
+
+
+
+ Sorting
+
+ To sort the search results by attributes click the column
+ header. The current sort attribute and direction is
+ indicated by an arrow.
+
+
+
+
+ Quick Filter
+
+ 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
+
+
+
+
+
+
+
+ button or press
+
+
+ Ctrl
+ F
+
+
+ . Enter (even parts of) a value into the input field, only
+ matching search results keep displayed. When hiding the
+ filter is removed.
+
+
+
+
+
+
+
+
+
+
+
+ Navigation
+
+ The
+
+
+
+
+
+
+
+ Locate DN in DIT
+ action locates and opens the entry of a selected DN in the
+ DIT.
+
+
+ The
+
+
+
+
+
+
+
+ Open Search Result
+ action locates and opens the selected search result.
+
+
+
+
+ Copy Table
+
+ The
+
+
+
+
+
+
+
+ Copy Table
+ action copies attributes as displayed in the table to the
+ system clipboard.
+
+
+ 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
+
+ Text Formats preferences
+
+ .
+
+
+
+
+ Editing
+
+ It is possible to add, edit or delete the displayed
+ attributes of the search results in the Search Result
+ editor.
+
+
+ To enter the edit mode using the default value editor select
+ a cell and press
+ Enter
+ or
+ F7
+ 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
+
+ Context Menu -> Edit Value With
+
+ .
+
+
+ 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.
+
+
+
+
+ Multivalued Editor
+
+ 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:
+
+
+
+ In the cell a multivalued attribute is displayed
+ as "X values: ..." to show the number of values
+ and a preview
+
+
+
+
+ When entering edit mode the Multivalued Editor
+ dialog is opened.
+
+
+
+
+
+ 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.
+
+
+ When editing a multivalued attribute the Multivalued Editor
+ is used as default value editor. When editing a singlevalued
+ attribute you could select
+
+ Context Menu -> Edit Value With ->
+
+
+
+
+
+
+
+ Multivalued Editor
+
+ .
+
+
+
+
+
Propchange: directory/sandbox/felixk/studio-ldapbrowser-help/src/main/docbook/2.23.1_tools_search_result_editor_features.xml
------------------------------------------------------------------------------
svn:eol-style = native