blob: c73e0270bd08ffe2ff57f4228cffdf556f86fa87 [file] [log] [blame]
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<section id="tools_entry_editor_features">
<title>Features</title>
<para>
This section describes the features of the Entry editor.
</para>
<simplesect id="tools_entry_editor_sorting">
<title>Sorting</title>
<para>
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
<link linkend="tools_entry_editor_sortdialog">
Sort Dialog
</link>
(
<emphasis role="strong">
Toolbar menu ->
<guiicon>
<inlinemediaobject>
<imageobject>
<imagedata contentdepth="1em" fileref="icons/sort.gif"
format="GIF" />
</imageobject>
</inlinemediaobject>
</guiicon>
Sorting
</emphasis>
):
</para>
</simplesect>
<simplesect id="tools_entry_editor_sortdialog">
<title>Sort dialog</title>
<para>
The default sorting behaviour of the entry editor could be
changed in this dialog.
<screenshot>
<mediaobject>
<imageobject>
<imagedata width="10cm"
fileref="images/tools_entry_editor_2.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
<informaltable frame="all">
<tgroup cols="3">
<colspec colname="Field" colwidth="1*"/>
<colspec colname="Description" colwidth="2*"/>
<colspec colname="Default" colwidth="1*"/>
<thead>
<row>
<entry>Field</entry>
<entry>Description</entry>
<entry>Default</entry>
</row>
</thead>
<tbody>
<row>
<entry>
ObjectClass and must attributes first
</entry>
<entry>
If enabled, objectClass and must attributes
are grouped at the top.
</entry>
<entry>on</entry>
</row>
<row>
<entry>Operational attributes last</entry>
<entry>
If enabled, operational attributes (e.g.
createTimestamp and modifyTimestamp) are
grouped at the bottom.
</entry>
<entry>on</entry>
</row>
<row>
<entry>Sort by</entry>
<entry>
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.
</entry>
<entry>
Attribute Description and Ascending
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</simplesect>
<simplesect id="tools_entry_editor_quickfilter">
<title>Quick Filter</title>
<para>
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
<guiicon>
<inlinemediaobject>
<imageobject>
<imagedata contentdepth="1em" 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) attribute descriptions or values
into the input fields, only matching attributes keep
displayed. When hiding the filter is removed.
<screenshot>
<mediaobject>
<imageobject>
<imagedata width="10cm"
fileref="images/tools_entry_editor_7.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
</simplesect>
<simplesect id="tools_entry_editor_visibleattributes">
<title>Visible attributes</title>
<para>
By default all user attributes of an entry are fetched and
displayed in the Entry editor. In the
<link linkend="preferences_entry_editor">
Entry editor preferences
</link>
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.
</para>
</simplesect>
<simplesect id="tools_entry_editor_folding">
<title>Folding</title>
<para>
By default attributes with more than 10 values are folded.
The attribute is displayed as single line containing the
number of values
<screenshot>
<mediaobject>
<imageobject>
<imagedata contentdepth="1em"
fileref="images/tools_entry_editor_9.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
<para>
Expand the attribute to make the values visible
(double-click works also). To expand/collapse all folded
attributes use the
<guiicon>
<inlinemediaobject>
<imageobject>
<imagedata contentdepth="1em" fileref="icons/collapseall.gif"
format="GIF" />
</imageobject>
</inlinemediaobject>
</guiicon>
Collapse All and
<guiicon>
<inlinemediaobject>
<imageobject>
<imagedata contentdepth="1em" fileref="icons/expandall.gif"
format="GIF" />
</imageobject>
</inlinemediaobject>
</guiicon>
Expand All and buttons from toolbar.
<screenshot>
<mediaobject>
<imageobject>
<imagedata contentdepth="5em"
fileref="images/tools_entry_editor_8.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
<para>
You could change this setting in
<link linkend="preferences_entry_editor">
Entry editor preferences
</link>.
</para>
</simplesect>
<simplesect id="tools_entry_editor_locatednindit">
<title>Locate DN in DIT</title>
<para>
If a value contains a distinguished name the
<guiicon>
<inlinemediaobject>
<imageobject>
<imagedata contentdepth="1em" fileref="icons/locate_dn_in_dit.gif"
format="GIF" />
</imageobject>
</inlinemediaobject>
</guiicon>
<emphasis role="strong">Locate DN in DIT</emphasis>
action can be used to locate and open the entry in the DIT.
</para>
</simplesect>
<simplesect id="tools_entry_editor_querybyexample">
<title>Query by example</title>
<para>
When selecting attributes these attribute-value-pairs are
used to build a search filter, this feature could be used
for "query by example".
<itemizedlist>
<listitem>
<para>
Select example attributes and choose
<emphasis role="strong">New Search...</emphasis>
from context menu. Watch the search filter in
the search dialog.
</para>
</listitem>
<listitem>
<para>
Select example attributes and choose
<emphasis role="strong">
Advanced -> Copy [NOT|AND|OR] Search Filter
</emphasis>
from context menu. This copies the search filter
to system clipboard.
</para>
</listitem>
</itemizedlist>
When building a filter necessary value encoding is supported
(*->\2a, (->\28, )->29, \->\5c, NUL->\00).
</para>
</simplesect>
<simplesect id="tools_entry_editor_editing">
<title>Editing</title>
<para>
It is possible to add, edit or delete attributes and values of
an entry in the Entry editor.
</para>
<para>
To enter the edit mode using the default value editor select a
value and press
<emphasis role="strong">Enter</emphasis>
or
<emphasis role="strong">F7</emphasis>
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
<emphasis role="strong">
Context Menu -> Edit Value With
</emphasis>.
</para>
<para>
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.
</para>
</simplesect>
</section>