Schemas Editor User's Guide

Reply-To: dev@directory.apache.org Delivered-To: mailing list commits@directory.apache.org Received: (qmail 21637 invoked by uid 99); 22 Jan 2007 17:27:43 -0000 Received: from herse.apache.org (HELO herse.apache.org) (140.211.11.133) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 22 Jan 2007 09:27:43 -0800 X-ASF-Spam-Status: No, hits=-9.4 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO eris.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 22 Jan 2007 09:27:35 -0800 Received: by eris.apache.org (Postfix, from userid 65534) id 32A421A981A; Mon, 22 Jan 2007 09:26:29 -0800 (PST) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r498718 - in /directory/ldapstudio/trunk/ldapstudio-rcp-help: ./ META-INF/ about_files/ resources/ src/ src/main/ src/main/resources/ Date: Mon, 22 Jan 2007 17:26:28 -0000 To: commits@directory.apache.org From: pamarcelot@apache.org X-Mailer: svnmailer-1.1.0 Message-Id: <20070122172629.32A421A981A@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: pamarcelot Date: Mon Jan 22 09:26:27 2007 New Revision: 498718 URL: http://svn.apache.org/viewvc?view=rev&rev=498718 Log: Adding ldapstudio-rcp-help for Help contents of the LDAP Studio RCP Plugin. Added: directory/ldapstudio/trunk/ldapstudio-rcp-help/ directory/ldapstudio/trunk/ldapstudio-rcp-help/.project directory/ldapstudio/trunk/ldapstudio-rcp-help/META-INF/ directory/ldapstudio/trunk/ldapstudio-rcp-help/META-INF/MANIFEST.MF directory/ldapstudio/trunk/ldapstudio-rcp-help/about_files/ directory/ldapstudio/trunk/ldapstudio-rcp-help/about_files/0_index.xml directory/ldapstudio/trunk/ldapstudio-rcp-help/build.xml directory/ldapstudio/trunk/ldapstudio-rcp-help/ivy.xml directory/ldapstudio/trunk/ldapstudio-rcp-help/plugin.xml directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/ directory/ldapstudio/trunk/ldapstudio-rcp-help/src/ directory/ldapstudio/trunk/ldapstudio-rcp-help/src/main/ directory/ldapstudio/trunk/ldapstudio-rcp-help/src/main/resources/ directory/ldapstudio/trunk/ldapstudio-rcp-help/src/main/resources/0_index.xml Added: directory/ldapstudio/trunk/ldapstudio-rcp-help/.project URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-rcp-help/.project?view=auto&rev=498718 ============================================================================== --- directory/ldapstudio/trunk/ldapstudio-rcp-help/.project (added) +++ directory/ldapstudio/trunk/ldapstudio-rcp-help/.project Mon Jan 22 09:26:27 2007 @@ -0,0 +1,22 @@ + + + ldapstudio-rcp-help + + + + + + org.eclipse.pde.ManifestBuilder + + + + + org.eclipse.pde.SchemaBuilder + + + + + + org.eclipse.pde.PluginNature + + Added: directory/ldapstudio/trunk/ldapstudio-rcp-help/META-INF/MANIFEST.MF URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-rcp-help/META-INF/MANIFEST.MF?view=auto&rev=498718 ============================================================================== --- directory/ldapstudio/trunk/ldapstudio-rcp-help/META-INF/MANIFEST.MF (added) +++ directory/ldapstudio/trunk/ldapstudio-rcp-help/META-INF/MANIFEST.MF Mon Jan 22 09:26:27 2007 @@ -0,0 +1,8 @@ +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: LDAP Studio Schemas Editor Help Plugin +Bundle-SymbolicName: org.apache.directory.ldapstudio.rcp.help;singleton:=true +Bundle-Version: 0.6.0 +Bundle-Localization: plugin +Eclipse-LazyStart: true +Bundle-Vendor: Apache Software Foundation Added: directory/ldapstudio/trunk/ldapstudio-rcp-help/about_files/0_index.xml URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-rcp-help/about_files/0_index.xml?view=auto&rev=498718 ============================================================================== --- directory/ldapstudio/trunk/ldapstudio-rcp-help/about_files/0_index.xml (added) +++ directory/ldapstudio/trunk/ldapstudio-rcp-help/about_files/0_index.xml Mon Jan 22 09:26:27 2007 @@ -0,0 +1,847 @@ + + + + + + Schemas Editor User's Guide + + 2007 + Apache Software Foundation + + + + This user guide is distributed under the Apache License. + + + + + +

+ Introduction + + LDAP Studio Schemas Editor is a plugin designed to handle Schemas files (in OpenLDAP format) of LDAP Server. + + + It allows browsing, creation, removal of schemas, object classes and attribute types. + +

+ + + + Getting Started + + This part of the guide provides you a sum up of the basic concepts of the Schemas Editor Plugin. + + + +

+ Views + + +

+ Hierarchy view + + Hierarchy view provides a hierarchical view of the resources in the schemas. From here, you can open + object classes and attribute types to edit them or browse the classes hierarchy. + + + + + + + + + + + + By default, the Hierarchy view is included in the Schemas perspective + + + Toolbar + + + The toolbar of the Hierarchy view contains the following buttons: + + + + + Sort Alphabetically - Displays the hierarchy by alphabetical order. + + + Sort Unalphabetically - Displays the hierarchy by unalphabetical order. + + + + + Icons + + + The following icons can appear in the Hierarchy view. + + + + + + + Icon + Description + + + + + + + + + + + + Object class + + + + + + + + + + Unresolved object class + + + + + + + + + + Folder + + + + + + + + + + Attribute type + + + + + +

+ + +

+ Schemas View + + Schemas view provides a view of all the opened schemas. From here, you can open object classes and attribute + types to edit them or browse the property of schemas files. You can also, add or delete attribute types, object + classes or schemas. + + + + + + + + + + + + By default, the Schemas view is included in the Schemas perspective + + + Toolbar + + + The toolbar of the Schemas view contains the following buttons: + + + + + Open a local schema file - Opens a file dialog to select the schema file. + + + Create a new schema - Opens a wizard to create a new schema. + + + Remove the selected schema from the pool - Removes the selected schema from the pool. + + + Create a new object class - Opens a wizard to create a new object class. + + + Create a new attribute type - Opens a wizard to create a new attribute type. + + + Delete - Deletes the selected element (attribute type or object class). (Note: A schema cannot be deleted, but only removed.) + + + Sort Alphabetically - Displays the hierarchy by alphabetical order. + + + Sort Unalphabetically - Displays the hierarchy by unalphabetical order. + + + + + Icons + + + The following icons can appear in the Schemas view. + + + + + + + Icon + Description + + + + + + + + + + + + Schema file + + + + + + + + + + Core schema file + + + + + + + + + + Folder + + + + + + + + + + Object class + + + + + + + + + + Attribute type + + + + + +

+ + +

+ Search View + + Search view provides a search field to search any ressources in the Workbench (object class or attribute type). + From here, you can open object classes and attribute types to edit them. + + + + + + + + + + + + By default, the Search view is included in the Schemas perspective + + + Toolbar + + + Search view provides the following search filter: + + + + + All metadata - Search elements by name, oid and description. + + + Name - Only search elements by name. + + + OID - Only search elements by OID. + + + Description - Only search elements by description. + + + Create a new attribute type - Opens a wizard to create a new attribute type. + + + + + Icons + + + The following icons can appear in the Search view. + + + + + + + Icon + Description + + + + + + + + + + + + Object class + + + + + + + + + + Attribute type + + + + + +

+ + +

+ Editors + + +

+ Attribute Type Editor + The attribute type editor is the one-stop shop where you can define all aspects of your attribute type. + + + + + + + + + + The Overview page is where the user can edit the properties of the attribute type. + User can edit: + + + the name + the OID + the description + the superior type + the usage + the syntax and syntax length + if the attribute type is obsolete + if the attribute type is single-value + if the attribute type is collective + if the attribute type is no-user-modification + all the matching rules (equality, ordering, substring) + + + + + + + + + + + + The Source code page is where the user can see the result of his actions in the Overview page and what source code will be generated in the schema file. +

+ + +

+ Object Class Editor + The object class editor is the one-stop shop where you can define all aspects of your object class. + + + + + + + + + + The Overview page is where the user can edit the properties of the object class. + User can edit: + + + the name + the OID + the description + the superior class + the class type + if the object class is obsolete + the mandatory attributes (add and remove) + the optionnal attributes (add and remove) + + + + + + + + + + + + The Source code page is where the user can see the result of his actions in the Overview page and what source code will be generated in the schema file. +

+ + +

+ Schema Editor + The schema editor is, at the moment, only a simple view of the source code of the schema file. + + + + + + + + + + This editor can be reached from the Schema view right-clicking on the schema icon and choosing View source code in the context menu. + + + + + + + + + +

+ + + + + Tasks + + This part of the guide provides you a list of the tasks you can accomplish with the Schemas Editor Plugin. + + + +

+ Opening a schema + In this section, you will learn how to open a schema file. + 1. In the Schemas view, click the Open a local schema file button in the toolbar, or select Open local schema file from the File menu. + + + + + + + + + + + + + + + + + + + 2. Browse the filesystem and select the schema file. Then click Open. + + + + + + + + + +

+ + +

+ Creating a new schema + In this section, you will learn how to create a new schema. + 1. In the Schemas view, click the Create a new schema button in the toolbar. + + + + + + + + + + 2. In the Name field, enter the name of the schema. + + + + + + + + + + 3. If a schema of the same name already exists, you will see this error. + + + + + + + + + + 4. Then click Finish. +

+ + +

+ Removing a schema + In this section, you will learn how to remove a schema. + 1. In the Schemas view, click the Remove the selected schema from the pool button in the toolbar. + + + + + + + + + + Note: It is not possible to remove a core schema +

+ + +

+ Creating a new object class + In this section, you will learn how to create a new object class. + 1. In the Schemas view, click the Create a new object class button in the toolbar. + Note: It is not possible to create a new object class in a core schema. + + + + + + + + + + 2. In the OID field, enter an OID of your choice. + If you want the OID field to be pre-filled with your organisation's OID, check the Prefix with default OID checkbox. + In the Name field, enter the name of the object class. + + + + + + + + + + 3. If an object class of the same name already exists, you will see this error. + + + + + + + + + + 4. If an element (object class or attribute type) already has the OID you provided, you will see this error. + + + + + + + + + + 5. If you enter a bad OID, you will see this error. + + + + + + + + + + 6. Then click Finish. +

+ + +

+ Creating a new attribute type + In this section, you will learn how to create a new attribute type. + 1. In the Schemas view, click the Create a new attribute type button in the toolbar. + Note: It is not possible to create a new attribute type in a core schema. + + + + + + + + + + 2. In the OID field, enter an OID of your choice. + If you want the OID field to be pre-filled with your organisation's OID, check the Prefix with default OID checkbox. + In the Name field, enter the name of the attribute type. + + + + + + + + + + 3. If an attribute type of the same name already exists, you will see this error. + + + + + + + + + + 4. If an element (object class or attribute type) already has the OID you provided, you will see this error. + + + + + + + + + + 5. If you enter a bad OID, you will see this error. + + + + + + + + + + 6. Then click Finish. +

+ + + + + Reference + + +

+ Object Class and Attribute Type Preferences + On the ObjectClass and AttributeType preferences page, you can indicate the following preferences. + + + + + + Option + Description + Default + + + + + Your organization's default OID + OID of your organisation. + 1.2.3.4.5.6 + + + Automatically prefix new elements with this OID + Select this option if you want new elements (object class or attribute type) to be prefixed with the OID provided in the field above in wizards. + Off + + + + + + Here is what the ObjectClass and AttributeType preferences page looks like: + + + + + + + + + +

+ + +

+ Schemas Preferences + On the Schemas preferences page, you can indicate the following preferences. + + + + + + Option + Description + Default + + + + + Default save/load dialogs directory + This option allows you to browse to a directory you want to set as default save/load dialogs directory. + User's Home directory + + + Save schemas configuration when exiting LDAP Studio + Select this option if you want the opened schemas to saved automatically when LDAP Studio exits. + On + + + Use specific core files + Select this option if you want to use different core files from the standard ones bundled with LDAP Studio. + Off + + + Core schemas directory + This option allows you to browse to your specific core schemas directory. + User's Home directory + + + + + + Here is what the Schemas preferences page looks like: + + + + + + + + + + + + +

+ + +

+ RFCs + + + + RFC 2252 - Lightweight Directory Access Protocol (v3): Attribute Syntax Definitions + + + + + RFC 4517 - Lightweight Directory Access Protocol (LDAP): Syntaxes and Matching Rules + + + + + RFC 4524 - COSINE LDAP/X.500 Schema + + + + + RFC 4519 - Lightweight Directory Access Protocol (LDAP): Schema for User Applications + + + +

+ + +

+ Release notes + LDAP Studio 0.6.0 (2007, late january) : initial release + Includes : + + + LDAP Studio RCP 0.6.0 + LDAP Studio Browser Plugin 0.6.0 + LDAP Studio Schemas Editor Plugin 0.6.0 + + +

+ + Added: directory/ldapstudio/trunk/ldapstudio-rcp-help/build.xml URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-rcp-help/build.xml?view=auto&rev=498718 ============================================================================== --- directory/ldapstudio/trunk/ldapstudio-rcp-help/build.xml (added) +++ directory/ldapstudio/trunk/ldapstudio-rcp-help/build.xml Mon Jan 22 09:26:27 2007 @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Added: directory/ldapstudio/trunk/ldapstudio-rcp-help/ivy.xml URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-rcp-help/ivy.xml?view=auto&rev=498718 ============================================================================== --- directory/ldapstudio/trunk/ldapstudio-rcp-help/ivy.xml (added) +++ directory/ldapstudio/trunk/ldapstudio-rcp-help/ivy.xml Mon Jan 22 09:26:27 2007 @@ -0,0 +1,26 @@ + + + + + + + + + Added: directory/ldapstudio/trunk/ldapstudio-rcp-help/plugin.xml URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-rcp-help/plugin.xml?view=auto&rev=498718 ============================================================================== --- directory/ldapstudio/trunk/ldapstudio-rcp-help/plugin.xml (added) +++ directory/ldapstudio/trunk/ldapstudio-rcp-help/plugin.xml Mon Jan 22 09:26:27 2007 @@ -0,0 +1,9 @@ + + + + + + + + + Added: directory/ldapstudio/trunk/ldapstudio-rcp-help/src/main/resources/0_index.xml URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-rcp-help/src/main/resources/0_index.xml?view=auto&rev=498718 ============================================================================== --- directory/ldapstudio/trunk/ldapstudio-rcp-help/src/main/resources/0_index.xml (added) +++ directory/ldapstudio/trunk/ldapstudio-rcp-help/src/main/resources/0_index.xml Mon Jan 22 09:26:27 2007 @@ -0,0 +1,25 @@ + + + + + + LDAP Studio User's Guide + + 2007 + Apache Software Foundation + + + + This user guide is distributed under the Apache License. + + + + + +

+ Introduction + + LDAP Studio is a Tooling Platform for LDAP Servers. It composed of an Eclipse RCP Application and a set of Eclipse plugins. + +