blob: 3904658e1e1668b2156e6f164a82e688b91dd182 [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_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 contentdepth="1em" fileref="icons/attribute_add.gif"
format="GIF" />
</imageobject>
</inlinemediaobject>
<emphasis role="strong">New Attribute...</emphasis>
button in the Entry editor's tool bar or select
<emphasis role="strong">New Attribute...</emphasis>
from the Entry editor's context menu or hit
<shortcut><keycombo>
<keycap>Shift</keycap>
<keycap>Strg</keycap>
<keycap>+</keycap>
</keycombo></shortcut>.
</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 scale="50"
fileref="images/tools_attribute_wizard_1.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
<para>
<informaltable frame="all">
<tgroup cols="3">
<colspec colname="Option" colwidth="1*" />
<colspec colname="Description" colwidth="1*" />
<colspec colname="Default" colwidth="1*" />
<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 scale="50"
fileref="images/tools_attribute_wizard_2.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
<para>
<informaltable frame="all">
<tgroup cols="2">
<colspec colname="Option" colwidth="1*" />
<colspec colname="Description" colwidth="3*" />
<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>