directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From seelm...@apache.org
Subject svn commit: r499621 - in /directory/ldapstudio/trunk/ldapstudio-browser-help: resources/images/ src/main/resources/
Date Wed, 24 Jan 2007 23:51:27 GMT
Author: seelmann
Date: Wed Jan 24 15:51:26 2007
New Revision: 499621

URL: http://svn.apache.org/viewvc?view=rev&rev=499621
Log:
Added LDIF Editor help.

Added:
    directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_1.png
  (with props)
    directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_2.png
  (with props)
    directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_3.png
  (with props)
    directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_4.png
  (with props)
    directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_5.png
  (with props)
    directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_6.png
  (with props)
    directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_7.png
  (with props)
    directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_8.png
  (with props)
    directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_9.png
  (with props)
Modified:
    directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.27_tools_ldif_editor.xml

Added: directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_1.png
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_1.png?view=auto&rev=499621
==============================================================================
Binary file - no diff available.

Propchange: directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_1.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_2.png
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_2.png?view=auto&rev=499621
==============================================================================
Binary file - no diff available.

Propchange: directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_2.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_3.png
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_3.png?view=auto&rev=499621
==============================================================================
Binary file - no diff available.

Propchange: directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_3.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_4.png
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_4.png?view=auto&rev=499621
==============================================================================
Binary file - no diff available.

Propchange: directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_4.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_5.png
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_5.png?view=auto&rev=499621
==============================================================================
Binary file - no diff available.

Propchange: directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_5.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_6.png
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_6.png?view=auto&rev=499621
==============================================================================
Binary file - no diff available.

Propchange: directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_6.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_7.png
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_7.png?view=auto&rev=499621
==============================================================================
Binary file - no diff available.

Propchange: directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_7.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_8.png
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_8.png?view=auto&rev=499621
==============================================================================
Binary file - no diff available.

Propchange: directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_8.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_9.png
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_9.png?view=auto&rev=499621
==============================================================================
Binary file - no diff available.

Propchange: directory/ldapstudio/trunk/ldapstudio-browser-help/resources/images/tools_ldif_editor_9.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Modified: directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.27_tools_ldif_editor.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.27_tools_ldif_editor.xml?view=diff&rev=499621&r1=499620&r2=499621
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.27_tools_ldif_editor.xml
(original)
+++ directory/ldapstudio/trunk/ldapstudio-browser-help/src/main/resources/2.27_tools_ldif_editor.xml
Wed Jan 24 15:51:26 2007
@@ -1,29 +1,353 @@
 <section id="tools_ldif_editor">
 	<title>LDIF editor</title>
-	<para>TODO..</para>
+
 	<para>
+		The LDIF editor could be used to edit LDIF files. 
+		It could handle LDIF content files as well as LDIF change files.
+		Files with appendix *.ldif are automatically handled by the LDIF editor.
+	</para>
+	
+	<para>
+		Note:
+		The LDIF editor is still in development. 
+		The handling of big LDIF files is a problem because the complete file 
+		is loaded into memory which may cause an OutOfMemoryException.
+		The syntax check doesn't work correctly. The error annotations and 
+		displayed messages are not very helpful at the moment.
+		Currently there is no URL support (jpegImage:&lt;file://)
+	</para>
+	
+	<simplesect id="tools_ldif_editor_using">
+		<title>Use LDIF editor</title>
+		<para>
+			To create a new LDIF file choose <emphasis role="strong">File -> New </emphasis>,

+			expand <emphasis role="strong">LDIF Browser</emphasis>, 
+			select <emphasis role="strong">LDIF File</emphasis> and press the Finish button.
+			To open an existing LDIF file choose <emphasis role="strong">File -> Open File</emphasis>,

+			that opens a file dialog where you could select the LDIF file. 
+			Within Eclipse you could also open a LDIF file from Navigator view.
+			To save the modified LDIF choose <emphasis role="strong">File -> Save</emphasis>
+			or <emphasis role="strong">File -> Save as</emphasis> and select a save
location 
+			and enter the file name.
+			The LDIF editor also supports default editor functionality like Copy/Paste, 
+			Undo/Redo and a Find/Replace dialog, see Edit menu. 
+		</para>
+	</simplesect>
+	
+	<simplesect id="tools_ldif_editor_connect">
+		<title>Connect with directory and its schema</title>
+		<para>
+			The LDIF editor could be connected to a directory server and its schema. 
+			A prerequirement is that the connection is defined in the 
+			<link linkend="tools_connections_view">
+				Connections view
+			</link>. 
+			Then you could select a connection from the drop-down list.
+			Doing this will provide you the following features:
+			<itemizedlist>
+				<listitem>
+					<para>
+						The Content Assistent will provide better attribute proposals.
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						The best value provider is choosen as default value editor.
+					</para>
+				</listitem>
+				<listitem>
+					<para>
+						The LDIF file could be executed, just press the the execute button.
+					</para>
+				</listitem>
+			</itemizedlist>			
+		</para>
+	</simplesect>
+
+	<simplesect id="tools_ldif_editor_syntax_coloring">
+		<title>Syntax Coloring</title>
+		<para>
+			Syntax coloring helps you to distinguish the different elements of a LDIF file. 
+			By default the following colors and fonts are used:
+		</para>	
+		<informaltable frame="all">
+			<tgroup cols="3">
+				<colspec colname="Element" />
+				<colspec colname="Color" />
+				<colspec colname="Example" />
+				<thead>
+					<row>
+						<entry>Element</entry>
+						<entry>Color</entry>
+						<entry>Example</entry>
+					</row>
+				</thead>
+				<tbody>
+					<row>
+						<entry>distinguished name</entry>
+						<entry>black and bold</entry>
+						<entry>
+							<screenshot>
+								<mediaobject>
+									<imageobject>
+										<imagedata
+											fileref="images/tools_ldif_editor_1.png" format="PNG" />
+									</imageobject>
+								</mediaobject>
+							</screenshot>
+						</entry>
+					</row>
+					<row>
+						<entry>attributes</entry>
+						<entry>violett and bold</entry>
+						<entry>
+							<screenshot>
+								<mediaobject>
+									<imageobject>
+										<imagedata
+											fileref="images/tools_ldif_editor_2.png" format="PNG" />
+									</imageobject>
+								</mediaobject>
+							</screenshot>
+						</entry>
+					</row>
+					<row>
+						<entry>values</entry>
+						<entry>blue</entry>
+						<entry>
+							<screenshot>
+								<mediaobject>
+									<imageobject>
+										<imagedata
+											fileref="images/tools_ldif_editor_3.png" format="PNG" />
+									</imageobject>
+								</mediaobject>
+							</screenshot>
+						</entry>
+					</row>
+					<row>
+						<entry>changetype add</entry>
+						<entry>green and bold</entry>
+						<entry>
+							<screenshot>
+								<mediaobject>
+									<imageobject>
+										<imagedata
+											fileref="images/tools_ldif_editor_4.png" format="PNG" />
+									</imageobject>
+								</mediaobject>
+							</screenshot>
+						</entry>
+					</row>
+					<row>
+						<entry>changetype modify</entry>
+						<entry>yellow and bold</entry>
+						<entry>
+							<screenshot>
+								<mediaobject>
+									<imageobject>
+										<imagedata
+											fileref="images/tools_ldif_editor_5.png" format="PNG" />
+									</imageobject>
+								</mediaobject>
+							</screenshot>
+						</entry>
+					</row>
+					<row>
+						<entry>changetype delete</entry>
+						<entry>red and bold</entry>
+						<entry>
+							<screenshot>
+								<mediaobject>
+									<imageobject>
+										<imagedata
+											fileref="images/tools_ldif_editor_6.png" format="PNG" />
+									</imageobject>
+								</mediaobject>
+							</screenshot>
+						</entry>
+					</row>
+					<row>
+						<entry>changetype moddn/modrdn</entry>
+						<entry>blue and bold</entry>
+						<entry>
+							<screenshot>
+								<mediaobject>
+									<imageobject>
+										<imagedata
+											fileref="images/tools_ldif_editor_7.png" format="PNG" />
+									</imageobject>
+								</mediaobject>
+							</screenshot>
+						</entry>
+					</row>
+					<row>
+						<entry>keywords</entry>
+						<entry>gray</entry>
+						<entry>
+							<screenshot>
+								<mediaobject>
+									<imageobject>
+										<imagedata
+											fileref="images/tools_ldif_editor_8.png" format="PNG" />
+									</imageobject>
+								</mediaobject>
+							</screenshot>
+						</entry>
+					</row>
+					<row>
+						<entry>comments</entry>
+						<entry>dark green</entry>
+						<entry>
+							<screenshot>
+								<mediaobject>
+									<imageobject>
+										<imagedata
+											fileref="images/tools_ldif_editor_9.png" format="PNG" />
+									</imageobject>
+								</mediaobject>
+							</screenshot>
+						</entry>
+					</row>
+				</tbody>
+			</tgroup>
+		</informaltable>
+		<para>
+			These colors and fonts could be changed in the 
+			<link linkend="preferences_ldif_editor">
+				LDIF Editor Syntax Coloring preferences
+			</link>.
+		</para>		
+	</simplesect>
+
+	<simplesect id="tools_ldif_editor_content_assistent">
+		<title>Content Assistent</title>
+		<para>
+			The LDIF editor provides a context-sensitive content assistent.
+			To start content assistence press 
+			<emphasis role="strong">Ctrl+Space</emphasis>, 
+			a popup with proposals is shown. 
+			You could select one using the cursur keys or the mouse, press 
+			<emphasis role="strong">Enter</emphasis> to apply 
+			the selected proposal. To close the popup press the 
+			<emphasis role="strong">ESC</emphasis> key.
+			The following list shows the supported proposals:
+		</para>
 		<itemizedlist>
-			<listitem>Syntax Coloring</listitem>
-			<listitem>Content Assistent</listitem>
-			<listitem>Templates</listitem>
-			<listitem>Formatting</listitem>
-			<listitem>Error Annotations</listitem>
-			<listitem>BASE-64 Tooltip</listitem>
-			<listitem>Edit Attribute Descripton</listitem>
-			<listitem>Edit Value / Value Editors</listitem>
-			<listitem>Edit Record / LDIF Entry Editor</listitem>
-			<listitem>Folding</listitem>
-			<listitem>Execute LDIF</listitem>
-			<listitem>Outline</listitem>
-			
-			
+			<listitem>
+				<para>
+					When starting a new record a popup with record templates is shown.
+				</para>
+			</listitem>
+			<listitem>
+				<para>
+					When writing an attribute in a content or add record a popup with 
+					a list of matching attributes is shown.
+				</para>
+			</listitem>
+			<listitem>
+				<para>
+					In an modify record the popup lists possible modify items.
+				</para>
+			</listitem>
 		</itemizedlist>
-	</para>
+	</simplesect>
+
+	<simplesect id="tools_ldif_editor_value_editors">
+		<title>Value Editors</title>
+		<para>
+			In LDIF values may only contain a subset of ASCII characters. 
+			Values with other characters (like accent mark) and even asiatic characters 
+			must be encoded using BASE-64. Also binary data like images or certificates
+			must be encoded. 
+		</para>
+		<para>
+			To edit such values the 
+			<link linkend="tools_value_editors">
+				Value editors
+			</link>
+			could be used.
+		</para>
+		<para>
+			To start a Value editor move the cursor to the attribute or value and select 
+			<emphasis role="strong">Edit Value</emphasis> from context menu or press 
+			<emphasis role="strong">F7</emphasis>.
+			This opens the default value editor dialog. 
+			You could also open a custom value editor by choosing one from 
+			<emphasis role="strong">Edit Value With</emphasis> in context menu.
+		</para>
+		<para>
+			To apply a modified value press the <emphasis role="strong">OK</emphasis>

+			button in the value editor dialog, the previous value is replaced by the new value. 
+			Of course in LDIF they are displayed BASE-64 encoded.
+		</para>
+	</simplesect>
+	
+	<simplesect id="tools_ldif_editor_record_editors">
+		<title>LDIF record editor</title>
+		<para>
+			It is possible to use the well-known Entry editor to edit content 
+			records and add records. Move the cursor to the record and choose 
+			<emphasis role="strong">Edit Record</emphasis> from context menu or 
+			press <emphasis role="strong">F8</emphasis>.
+			This opens the LDIF record editor. 
+			You can add, modify and delete attributes. 
+			To apply the modification press <emphasis role="strong">OK</emphasis>, 
+			the previous record is replaced by the new one.
+		</para>
+	</simplesect>
+
+	<simplesect id="tools_ldif_editor_base64">
+		<title>Reading BASE-64 values</title>
+		<para>
+			There are two ways to make BASE-64 values human readable:
+		</para>
+		<itemizedlist>
+			<listitem>
+				<para>
+					Move the mouse over the value, a tooltip with the value is displayed. 
+					This works only for text-based values, not for binary values.
+				</para>
+			</listitem>
+			<listitem>
+				<para>
+					Open the value editor.
+				</para>
+			</listitem>
+		</itemizedlist>
+	</simplesect>
+
+	<simplesect id="tools_ldif_editor_formatting">
+		<title>Formatting</title>
+		<para>
+			To format the document or the selected record according the 
+			<link linkend="preferences_ldif_editor">
+				LDIF Editor preferences
+			</link>
+			choose <emphasis role="strong">Format</emphasis> from context menu.
+		</para>
+	</simplesect>
+	
+	<simplesect id="tools_ldif_editor_folding">
+		<title>Folding</title>
+		<para>
+			Multi-lined comments, records and multi-lined values could be folded. 
+			There is a (+) and (-) in the left ruler to collapse and expand these.
+			By default multi-lined comments and multi-lined values are folded. 
+			This behaviour could be changed in 
+			<link linkend="preferences_ldif_editor">
+				LDIF Editor preferences
+			</link>.
+		</para>
+	</simplesect>
+	
+	<simplesect id="tools_ldif_editor_line_numbers">
+		<title>Line numbers</title>
+		<para>
+			To show/hide line numbers toggle the 
+			<emphasis role="strong">Show Line Number</emphasis> 
+			in the context menu of the left ruler.
+		</para>
+	</simplesect>
 	
-	<!-- 
-	Outline, select connection + execute, content vs.
-	modify, content assist, templates, errors and warnings,
-	perferences, folding, context menu (edit attribute,
-	value, record), formatting, UTF-8/BASE64
-	 -->
 </section>



Mime
View raw message