You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by se...@apache.org on 2009/11/01 21:29:43 UTC

svn commit: r831758 - in /directory/studio/trunk/schemaeditor-help/src/main: docbook/ resources/html/images/

Author: seelmann
Date: Sun Nov  1 20:29:42 2009
New Revision: 831758

URL: http://svn.apache.org/viewvc?rev=831758&view=rev
Log:
Updated user documentation
o Create Project (offine, online)
o Merge Schema
o What's new in 1.5.0

Added:
    directory/studio/trunk/schemaeditor-help/src/main/docbook/2.5.4_merge_schemas.xml
    directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_merge-schemas-wizard_page-1.png   (with props)
    directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_merge-schemas-wizard_page-2.png   (with props)
    directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_merge-schemas_result.png   (with props)
Modified:
    directory/studio/trunk/schemaeditor-help/src/main/docbook/0_index.xml
    directory/studio/trunk/schemaeditor-help/src/main/docbook/1.2.3_views_projects.xml
    directory/studio/trunk/schemaeditor-help/src/main/docbook/2.1_creating_new_project.xml
    directory/studio/trunk/schemaeditor-help/src/main/docbook/2.5_importing_schemas.xml
    directory/studio/trunk/schemaeditor-help/src/main/docbook/4_whats_new.xml
    directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_new-project-wizard_page-1.png
    directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_new-project-wizard_page-2_offline.png
    directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_new-project-wizard_page-2_online.png

Modified: directory/studio/trunk/schemaeditor-help/src/main/docbook/0_index.xml
URL: http://svn.apache.org/viewvc/directory/studio/trunk/schemaeditor-help/src/main/docbook/0_index.xml?rev=831758&r1=831757&r2=831758&view=diff
==============================================================================
--- directory/studio/trunk/schemaeditor-help/src/main/docbook/0_index.xml (original)
+++ directory/studio/trunk/schemaeditor-help/src/main/docbook/0_index.xml Sun Nov  1 20:29:42 2009
@@ -22,6 +22,7 @@
   <!ENTITY tasks_importing_schemas_from_xml_files SYSTEM "2.5.1_importing_schemas_from_xml_files.xml">
   <!ENTITY tasks_importing_schemas_from_openldap_files SYSTEM "2.5.2_importing_schemas_from_openldap_files.xml">
   <!ENTITY tasks_importing_core_schemas_files SYSTEM "2.5.3_importing_core_schemas_files.xml">
+  <!ENTITY tasks_merge_schemas SYSTEM "2.5.4_merge_schemas.xml">
   <!ENTITY tasks_exporting_schemas SYSTEM "2.6_exporting_schemas.xml">
   <!ENTITY tasks_exporting_schemas_as_xml_files SYSTEM "2.6.1_exporting_schemas_as_xml_files.xml">
   <!ENTITY tasks_exporting_schemas_as_openldap_files SYSTEM "2.6.2_exporting_schemas_as_openldap_files.xml">

Modified: directory/studio/trunk/schemaeditor-help/src/main/docbook/1.2.3_views_projects.xml
URL: http://svn.apache.org/viewvc/directory/studio/trunk/schemaeditor-help/src/main/docbook/1.2.3_views_projects.xml?rev=831758&r1=831757&r2=831758&view=diff
==============================================================================
--- directory/studio/trunk/schemaeditor-help/src/main/docbook/1.2.3_views_projects.xml (original)
+++ directory/studio/trunk/schemaeditor-help/src/main/docbook/1.2.3_views_projects.xml Sun Nov  1 20:29:42 2009
@@ -76,7 +76,7 @@
 								</imageobject>
 							</mediaobject>
 						</entry>
-						<entry>Closed project</entry>
+						<entry>Closed offline project</entry>
 					</row>
 					<row>
 						<entry align="center">
@@ -87,7 +87,29 @@
 								</imageobject>
 							</mediaobject>
 						</entry>
-						<entry>Opened project</entry>
+						<entry>Opened offline project</entry>
+					</row>
+					<row>
+						<entry align="center">
+							<mediaobject>
+								<imageobject>
+									<imagedata scale="50"
+										fileref="images/icons_project-online-closed.gif" format="GIF" />
+								</imageobject>
+							</mediaobject>
+						</entry>
+						<entry>Closed online project</entry>
+					</row>
+					<row>
+						<entry align="center">
+							<mediaobject>
+								<imageobject>
+									<imagedata scale="50"
+										fileref="images/icons_project-online.gif" format="GIF" />
+								</imageobject>
+							</mediaobject>
+						</entry>
+						<entry>Opened online project</entry>
 					</row>
 				</tbody>
 			</tgroup>

Modified: directory/studio/trunk/schemaeditor-help/src/main/docbook/2.1_creating_new_project.xml
URL: http://svn.apache.org/viewvc/directory/studio/trunk/schemaeditor-help/src/main/docbook/2.1_creating_new_project.xml?rev=831758&r1=831757&r2=831758&view=diff
==============================================================================
--- directory/studio/trunk/schemaeditor-help/src/main/docbook/2.1_creating_new_project.xml (original)
+++ directory/studio/trunk/schemaeditor-help/src/main/docbook/2.1_creating_new_project.xml Sun Nov  1 20:29:42 2009
@@ -34,10 +34,12 @@
 		The creation of a new Schema Project is a two-step process:
 		<orderedlist numeration="arabic">
 			<listitem>
-				<para>Define the name of the project.</para>
+				<para>Define the name an the type of the project.</para>
 			</listitem>
 			<listitem>
-				<para>Select the 'core' schema files to import.</para>
+				<para>Select the 'core' schema files to import or select 
+				the directory server from which the schema should be 
+				imported.</para>
 			</listitem>
 		</orderedlist>
 	</para>
@@ -96,7 +98,7 @@
 		</para>
 	</simplesect>
 	<simplesect>
-		<title>Page 2</title>
+		<title>Page 2 (offline)</title>
 		<para>
 			The second page allows you to select the 'core' schema files
 			to import.
@@ -117,4 +119,22 @@
 			the 'core' schema files you want to import.
 		</para>
 	</simplesect>
+	<simplesect>
+		<title>Page 2 (online)</title>
+		<para>
+			The second page allows you to select the connection to the 
+			directory server from which the schema should be loaded.
+		</para>
+		<para>
+			<screenshot>
+				<mediaobject>
+					<imageobject>
+						<imagedata scale="50"
+							fileref="images/tasks_new-project-wizard_page-2_online.png"
+							format="PNG" />
+					</imageobject>
+				</mediaobject>
+			</screenshot>
+		</para>
+	</simplesect>
 </section>
\ No newline at end of file

Added: directory/studio/trunk/schemaeditor-help/src/main/docbook/2.5.4_merge_schemas.xml
URL: http://svn.apache.org/viewvc/directory/studio/trunk/schemaeditor-help/src/main/docbook/2.5.4_merge_schemas.xml?rev=831758&view=auto
==============================================================================
--- directory/studio/trunk/schemaeditor-help/src/main/docbook/2.5.4_merge_schemas.xml (added)
+++ directory/studio/trunk/schemaeditor-help/src/main/docbook/2.5.4_merge_schemas.xml Sun Nov  1 20:29:42 2009
@@ -0,0 +1,109 @@
+<!--
+	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="tasks_merge_schemas">
+	<title>Merge schemas</title>
+	<para>
+		You could merge schemas, object classes and attribute types from one
+		schema project to another using the Merge Schemas wizard.
+		To start the wizard choose
+		<emphasis role="strong">
+			Import >
+			<imageobject>
+				<imagedata scale="50"
+					fileref="images/icons_schemas-import.gif" format="GIF" />
+			</imageobject>
+			Merge Schemas from other Projects
+		</emphasis>
+		from the context menu of the Schema view.
+	</para>
+	<para>The following wizard appears:</para>
+	<para>
+		<screenshot>
+			<mediaobject>
+				<imageobject>
+					<imagedata scale="50"
+						fileref="images/tasks_merge-schemas-wizard_page-1.png"
+						format="PNG" />
+				</imageobject>
+			</mediaobject>
+		</screenshot>
+	</para>
+	<para>
+		Check each schema, object class and/or attribute type from to merge to the current
+		schema project and click on the	<emphasis role="strong">Next</emphasis>	button.
+	</para>
+	<para>The second wizard page appears:</para>
+	<para>
+		<screenshot>
+			<mediaobject>
+				<imageobject>
+					<imagedata scale="50"
+						fileref="images/tasks_merge-schemas-wizard_page-2.png"
+						format="PNG" />
+				</imageobject>
+			</mediaobject>
+		</screenshot>
+	</para>
+	<para>
+		Select merge options.
+		<informaltable frame="all">
+			<tgroup cols="3">
+				<colspec colname="Option" colwidth="1*" />
+				<colspec colname="Description" colwidth="2*" />
+				<colspec colname="Default" colwidth="1*" />
+				<thead>
+					<row>
+						<entry>Option</entry>
+						<entry>Description</entry>
+						<entry>Default</entry>
+					</row>
+				</thead>
+				<tbody>
+					<row>
+						<entry>Replace unknown syntax</entry>
+						<entry>
+							If checked, unknown syntaxes are replaced by Directory String syntax, 
+							and appropriate matching rules (caseIgnoreMatch, 
+							caseIgnoreSubstringsMatch) are set.
+						</entry>
+						<entry>checked</entry>
+					</row>
+					<row>
+						<entry>Merge dependencies</entry>
+						<entry>
+							If checked, dependent schema elements (super classes, 
+							super attribute types, may and must attributes) are also merged.
+						</entry>
+						<entry>checked</entry>
+					</row>
+					<row>
+						<entry>Merge inherited attributes</entry>
+						<entry>
+							If checked, must and may attributes that are not defined 
+							in the class hierarchy in the target schema are added 
+							to the merged object class.
+						</entry>
+						<entry>checked</entry>
+					</row>
+				</tbody>
+			</tgroup>
+		</informaltable>
+	</para>
+	
+</section>

Modified: directory/studio/trunk/schemaeditor-help/src/main/docbook/2.5_importing_schemas.xml
URL: http://svn.apache.org/viewvc/directory/studio/trunk/schemaeditor-help/src/main/docbook/2.5_importing_schemas.xml?rev=831758&r1=831757&r2=831758&view=diff
==============================================================================
--- directory/studio/trunk/schemaeditor-help/src/main/docbook/2.5_importing_schemas.xml (original)
+++ directory/studio/trunk/schemaeditor-help/src/main/docbook/2.5_importing_schemas.xml Sun Nov  1 20:29:42 2009
@@ -22,5 +22,6 @@
 	&tasks_importing_schemas_from_xml_files;
 	&tasks_importing_schemas_from_openldap_files;
 	&tasks_importing_core_schemas_files;
+	&tasks_merge_schemas;
 
 </section>
\ No newline at end of file

Modified: directory/studio/trunk/schemaeditor-help/src/main/docbook/4_whats_new.xml
URL: http://svn.apache.org/viewvc/directory/studio/trunk/schemaeditor-help/src/main/docbook/4_whats_new.xml?rev=831758&r1=831757&r2=831758&view=diff
==============================================================================
--- directory/studio/trunk/schemaeditor-help/src/main/docbook/4_whats_new.xml (original)
+++ directory/studio/trunk/schemaeditor-help/src/main/docbook/4_whats_new.xml Sun Nov  1 20:29:42 2009
@@ -20,6 +20,34 @@
 	<title>What's new</title>
 
 	<simplesect>
+		<title>What's new in 1.5.0</title>
+		<para>
+			<emphasis role="strong">Online Schema</emphasis>
+		</para>
+		<para>
+			Schema projects can be created from an existing	schema
+			from a directory server.		
+		</para>
+		<para>
+			<emphasis role="strong">Merge Schemas</emphasis>
+		</para>
+		<para>
+			Schemas, object classes and attribute types can be merged
+			between schema projects.
+		</para>
+		<para>
+			<emphasis role="strong">A number of bug fixes</emphasis>
+		</para>
+		<para>
+			Besides these key new features, the Schema Editor plugin has
+			received a number of bug fixes. A detailed report is
+			provided in the
+			<link linkend="release_notes">Release Notes</link>
+			section.
+		</para>
+	</simplesect>
+
+	<simplesect>
 		<title>What's new in 1.4.0</title>
 		<para>
 			<emphasis role="strong">Internationalization</emphasis>

Added: directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_merge-schemas-wizard_page-1.png
URL: http://svn.apache.org/viewvc/directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_merge-schemas-wizard_page-1.png?rev=831758&view=auto
==============================================================================
Binary file - no diff available.

Propchange: directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_merge-schemas-wizard_page-1.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_merge-schemas-wizard_page-2.png
URL: http://svn.apache.org/viewvc/directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_merge-schemas-wizard_page-2.png?rev=831758&view=auto
==============================================================================
Binary file - no diff available.

Propchange: directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_merge-schemas-wizard_page-2.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_merge-schemas_result.png
URL: http://svn.apache.org/viewvc/directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_merge-schemas_result.png?rev=831758&view=auto
==============================================================================
Binary file - no diff available.

Propchange: directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_merge-schemas_result.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Modified: directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_new-project-wizard_page-1.png
URL: http://svn.apache.org/viewvc/directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_new-project-wizard_page-1.png?rev=831758&r1=831757&r2=831758&view=diff
==============================================================================
Binary files - no diff available.

Modified: directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_new-project-wizard_page-2_offline.png
URL: http://svn.apache.org/viewvc/directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_new-project-wizard_page-2_offline.png?rev=831758&r1=831757&r2=831758&view=diff
==============================================================================
Binary files - no diff available.

Modified: directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_new-project-wizard_page-2_online.png
URL: http://svn.apache.org/viewvc/directory/studio/trunk/schemaeditor-help/src/main/resources/html/images/tasks_new-project-wizard_page-2_online.png?rev=831758&r1=831757&r2=831758&view=diff
==============================================================================
Binary files - no diff available.