<!--
  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_browser_view_dit">
	<title>DIT category</title>

	<para>
		This section describes the DIT category in the LDAP Browser
		view.
	</para>

	<simplesect id="tools_browser_view_dit_navigation">
		<title>Navigation</title>
		<para>
			In the DIT category the directory information tree of the
			LDAP directory is displayed in its natural hierarchical
			structure. The first hierachy level contains the base
			entries, the Root DSE and the schema entry. When expanding
			an entry its direct children are fetched from directory. To
			expand and collapse an entry you could also double-click.
		</para>
	</simplesect>

	<simplesect id="tools_browser_view_dit_child_detection">
		<title>Children detection</title>
		<para>
			While browsing the directory the LDAP Browser tries to find
			out if a fetched entry has children. Entries without
			children couldn't be expanded. This behaviour could be
			changed in the
			<link linkend="preferences_browser_view">
				LDAP Browser preferences
			</link>
			.
		</para>
	</simplesect>

	<simplesect id="tools_browser_view_dit_labels">
		<title>Labels</title>
		<para>
			By default the RDN of the entries is used as label and the
			length of the label is limited to 50 characters. This
			behaviour could be changed in the
			<link linkend="preferences_browser_view">
				LDAP Browser preferences
			</link>
			. For the Base entries always the whole DN is used as label.
		</para>
		<para>
			If an entry has child entries the number of children is
			appended in parentheses to the label. If the directory
			server returned a partial result (e.g. because of count or
			time limits) a plus (+) character is appended to the number
			of children to indicate that there are more child entries.
			Note: The limit parameters are inherited from connection
			properties.
			<screenshot>
				<mediaobject>
					<imageobject>
						<imagedata scale="50"
							fileref="images/tools_browser_view_7.png" format="PNG" />
					</imageobject>
				</mediaobject>
			</screenshot>

		</para>
	</simplesect>

	<simplesect id="tools_browser_view_dit_icons">
		<title>Icons</title>
		<para>
			The following icons are used to distinguish entry types:
		</para>
		<informaltable frame="all">
			<tgroup cols="2" align="left" colsep="1" rowsep="1">
				<colspec colname="Icon" align="center" colwidth="1*" />
				<colspec colname="Description" colwidth="3*" />
				<thead>
					<row>
						<entry>Icon</entry>
						<entry>Description</entry>
					</row>
				</thead>
				<tbody>
					<row>
						<entry>
							<guiicon>
								<inlinemediaobject>
									<imageobject>
										<imagedata scale="50"
											fileref="icons/entry_person.gif" format="GIF" />
									</imageobject>
								</inlinemediaobject>
							</guiicon>
						</entry>
						<entry>Entry with object class person, inetOrgPerson, posixAccount, user</entry>
					</row>
					<row>
						<entry>
							<guiicon>
								<inlinemediaobject>
									<imageobject>
										<imagedata scale="50"
											fileref="icons/entry_group.gif" format="GIF" />
									</imageobject>
								</inlinemediaobject>
							</guiicon>
						</entry>
						<entry>Entry with object class groupOfNames, groupOfUniqueNames, posixGroup, group</entry>
					</row>
					<row>
						<entry>
							<guiicon>
								<inlinemediaobject>
									<imageobject>
										<imagedata scale="50"
											fileref="icons/entry_org.gif" format="GIF" />
									</imageobject>
								</inlinemediaobject>
							</guiicon>
						</entry>
						<entry>Entry with object class organization, organizationalUnit, container</entry>
					</row>
					<row>
						<entry>
							<guiicon>
								<inlinemediaobject>
									<imageobject>
										<imagedata scale="50"
											fileref="icons/entry_dc.gif" format="GIF" />
									</imageobject>
								</inlinemediaobject>
							</guiicon>
						</entry>
						<entry>Entry with object class domain, domainComponent, country, locality</entry>
					</row>
					<row>
						<entry>
							<guiicon>
								<inlinemediaobject>
									<imageobject>
										<imagedata scale="50"
											fileref="icons/entry_alias.png" format="GIF" />
									</imageobject>
								</inlinemediaobject>
							</guiicon>
						</entry>
						<entry>Entry with object class alias</entry>
					</row>
					<row>
						<entry>
							<guiicon>
								<inlinemediaobject>
									<imageobject>
										<imagedata scale="50"
											fileref="icons/entry_ref.png" format="GIF" />
									</imageobject>
								</inlinemediaobject>
							</guiicon>
						</entry>
						<entry>Entry with object class referral</entry>
					</row>
					<row>
						<entry>
							<guiicon>
								<inlinemediaobject>
									<imageobject>
										<imagedata scale="50"
											fileref="icons/browser_schemabrowsereditor.gif" format="GIF" />
									</imageobject>
								</inlinemediaobject>
							</guiicon>
						</entry>
						<entry>The schema entry.</entry>
					</row>
					<row>
						<entry>
							<guiicon>
								<inlinemediaobject>
									<imageobject>
										<imagedata scale="50"
											fileref="icons/entry_root.gif" format="GIF" />
									</imageobject>
								</inlinemediaobject>
							</guiicon>
						</entry>
						<entry>The root DSE entry.</entry>
					</row>
					<row>
						<entry>
							<guiicon>
								<inlinemediaobject>
									<imageobject>
										<imagedata scale="50"
											fileref="icons/entry_default.gif" format="GIF" />
									</imageobject>
								</inlinemediaobject>
							</guiicon>
						</entry>
						<entry>All other entries</entry>
					</row>
				</tbody>
			</tgroup>
		</informaltable>
	</simplesect>

	<simplesect id="tools_browser_view_dit_aliases_and_referrals">
		<title>Alias and referral entries</title>
		<para>
			To manage alias entries you have the following options:
			<itemizedlist>
				<listitem>
					<para>Disable the options "Finding Base DN" and "Search"
					in the "Aliases Dereferencing" group of the 
					<link
						linkend="tools_connection_properties_browser_options">
						Connection properties
					</link>
					. This setting will display 
					<guiicon>
						<inlinemediaobject>
							<imageobject>
								<imagedata scale="50"
									fileref="icons/entry_alias.png" format="GIF" />
							</imageobject>
						</inlinemediaobject>
					</guiicon>
					 alias entries in the tree.
					</para>
				</listitem>
				<listitem>
					<para>If you know that an entry contains alias child entriy you could
					select <emphasis role="strong">Fetch > Fetch Aliases </emphasis>
					from the browser's context menu.</para>
				</listitem>
			</itemizedlist>
		</para>
		
		<para>
			To manage referral entries you have the following options
			<itemizedlist>
				<listitem>
					<para>Enable the option "Use ManageDsaIT control"
					in the "Controls" group of the 
					<link
						linkend="tools_connection_properties_browser_options">
						Connection properties
					</link>
					. This setting will display 
					<guiicon>
						<inlinemediaobject>
							<imageobject>
								<imagedata scale="50"
									fileref="icons/entry_ref.png" format="GIF" />
							</imageobject>
						</inlinemediaobject>
					</guiicon>
					referral entries in the tree.
					</para>
				</listitem>
				<listitem>
					<para>If you know that an entry contains referrals child entriy you could
					select <emphasis role="strong">Fetch > Fetch Referrals </emphasis>
					from the browser's context menu.</para>
				</listitem>
			</itemizedlist>
		</para>		
	</simplesect>

	<simplesect id="tools_browser_view_dit_folding">
		<title>Folding</title>
		<para>
			By default the entries of large branches are folded into
			virtual folders
			<guiicon>
				<inlinemediaobject>
					<imageobject>
						<imagedata scale="50" fileref="icons/folder.gif"
							format="GIF" />
					</imageobject>
				</inlinemediaobject>
			</guiicon>
			each with 100 entries. This may help to keep the displayed
			tree smaller. This behaviour could be changed in the
			<link linkend="preferences_browser_view">
				LDAP Browser preferences
			</link>
			.
			<screenshot>
				<mediaobject>
					<imageobject>
						<imagedata contentdepth="5em"
							fileref="images/tools_browser_view_6.png" format="PNG" />
					</imageobject>
				</mediaobject>
			</screenshot>
		</para>
	</simplesect>

	<simplesect id="tools_browser_view_dit_filter">
		<title>Filter Children</title>
		<para>
			With the
			<guiicon>
				<inlinemediaobject>
					<imageobject>
						<imagedata scale="50" fileref="icons/filter_dit.gif"
							format="GIF" />
					</imageobject>
				</inlinemediaobject>
			</guiicon>
			<emphasis role="strong">Filter Children</emphasis>
			action you can define a filter to select entries returned by
			the server for your needs. You could recognise a filtered
			entry by its modified icon and label.
			<screenshot>
				<mediaobject>
					<imageobject>
						<imagedata contentdepth="2em"
							fileref="images/tools_browser_view_10.png" format="PNG" />
					</imageobject>
				</mediaobject>
			</screenshot>
		</para>
	</simplesect>

</section>