You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by pa...@apache.org on 2007/01/23 16:34:21 UTC
svn commit: r499055 - in /directory/ldapstudio/trunk/ldapstudio-rcp-help: ./
META-INF/ resources/css/ resources/images/ src/main/resources/
Author: pamarcelot
Date: Tue Jan 23 07:34:20 2007
New Revision: 499055
URL: http://svn.apache.org/viewvc?view=rev&rev=499055
Log:
Updating LDAP Studio Help Plugin.
Added:
directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/css/
directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/css/book.css
directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/
directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/about.png (with props)
directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/bug-report.png (with props)
directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/jira-screenshot.png (with props)
directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/manage-configuration.png (with props)
directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/search-updates.png (with props)
Modified:
directory/ldapstudio/trunk/ldapstudio-rcp-help/META-INF/MANIFEST.MF
directory/ldapstudio/trunk/ldapstudio-rcp-help/build.xml
directory/ldapstudio/trunk/ldapstudio-rcp-help/src/main/resources/0_index.xml
Modified: 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=diff&rev=499055&r1=499054&r2=499055
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-rcp-help/META-INF/MANIFEST.MF (original)
+++ directory/ldapstudio/trunk/ldapstudio-rcp-help/META-INF/MANIFEST.MF Tue Jan 23 07:34:20 2007
@@ -1,7 +1,7 @@
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-Name: LDAP Studio Help Plugin
+Bundle-SymbolicName: org.apache.directory.ldapstudio.help;singleton:=true
Bundle-Version: 0.6.0
Bundle-Localization: plugin
Eclipse-LazyStart: true
Modified: directory/ldapstudio/trunk/ldapstudio-rcp-help/build.xml
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-rcp-help/build.xml?view=diff&rev=499055&r1=499054&r2=499055
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-rcp-help/build.xml (original)
+++ directory/ldapstudio/trunk/ldapstudio-rcp-help/build.xml Tue Jan 23 07:34:20 2007
@@ -17,7 +17,7 @@
under the License.
-->
<project default="jar" xmlns:ivy="antlib:fr.jayasoft.ivy.ant">
- <property name="project.name" value="org.apache.directory.ldapstudio.rcp.help" />
+ <property name="project.name" value="org.apache.directory.ldapstudio.help" />
<property name="project.version" value="0.6.0" />
<property name="project.output" value="${basedir}/target" />
Added: directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/css/book.css
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/css/book.css?view=auto&rev=499055
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/css/book.css (added)
+++ directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/css/book.css Tue Jan 23 07:34:20 2007
@@ -0,0 +1,113 @@
+
+P.Code {
+ display: block;
+ text-align: left;
+ text-indent: 0.00pt;
+ margin-top: 0.000000pt;
+ margin-bottom: 0.000000pt;
+ margin-right: 0.000000pt;
+ margin-left: 15pt;
+ font-size: 10.000000pt;
+ font-weight: normal;
+ font-style: normal;
+ color: #4444CC;
+ text-decoration: none;
+ vertical-align: baseline;
+ text-transform: none;
+ font-family: "Courier New", Courier, monospace;
+}
+H6.CaptionFigColumn {
+ display: block;
+ text-align: left;
+ text-indent: 0.000000pt;
+ margin-top: 3.000000pt;
+ margin-bottom: 11.000000pt;
+ margin-right: 0.000000pt;
+ margin-left: 0.000000pt;
+ font-size: 9.000000pt;
+ font-weight: bold;
+ font-style: Italic;
+ color: #000000;
+ text-decoration: none;
+ vertical-align: baseline;
+ text-transform: none;
+}
+P.Note {
+ display: block;
+ text-align: left;
+ text-indent: 0pt;
+ margin-top: 19.500000pt;
+ margin-bottom: 19.500000pt;
+ margin-right: 0.000000pt;
+ margin-left: 30pt;
+ font-size: 11.000000pt;
+ font-weight: normal;
+ font-style: Italic;
+ color: #000000;
+ text-decoration: none;
+ vertical-align: baseline;
+ text-transform: none;
+}
+EM.UILabel {
+ font-weight: Bold;
+ font-style: normal;
+ text-decoration: none;
+ vertical-align: baseline;
+ text-transform: none;
+}
+EM.CodeName {
+ font-weight: Bold;
+ font-style: normal;
+ text-decoration: none;
+ vertical-align: baseline;
+ text-transform: none;
+ font-family: "Courier New", Courier, monospace;
+}
+
+body, html { border: 0px }
+
+
+/* following font face declarations need to be removed for DBCS */
+
+body, h1, h2, h3, h4, h5, h6, p, table, td, caption, th, ul, ol, dl, li, dd, dt {font-family: Arial, Helvetica, sans-serif; color: #000000}
+pre { font-family: "Courier New", Courier, monospace;}
+
+/* end font face declarations */
+
+/* following font size declarations should be OK for DBCS */
+body, h1, h2, h3, h4, h5, h6, p, table, td, caption, th, ul, ol, dl, li, dd, dt {font-size: 10pt; }
+pre { font-size: 10pt}
+
+/* end font size declarations */
+
+body { background: #FFFFFF; margin-bottom: 1em }
+h1 { font-size: 18pt; margin-top: 5; margin-bottom: 1 }
+h2 { font-size: 14pt; margin-top: 25; margin-bottom: 3 }
+h3 { font-size: 11pt; margin-top: 20; margin-bottom: 3 }
+h4 { font-size: 10pt; margin-top: 20; margin-bottom: 3; font-style: italic }
+p { margin-top: 10px; margin-bottom: 10px }
+pre { margin-left: 6; font-size: 9pt; color: #4444CC }
+a:link { color: #0000FF }
+a:hover { color: #000080 }
+a:visited { text-decoration: underline }
+ul { margin-top: 10px; margin-bottom: 10px; }
+li { margin-top: 5px; margin-bottom: 5px; }
+li p { margin-top: 5px; margin-bottom: 5px; }
+ol { margin-top: 10px; margin-bottom: 10px; }
+dl { margin-top: 10px; margin-bottom: 10px; }
+dt { margin-top: 5px; margin-bottom: 5px; font-weight: bold; }
+dd { margin-top: 5px; margin-bottom: 5px; }
+strong { font-weight: bold}
+em { font-style: italic}
+var { font-style: italic}
+div.revision { border-left-style: solid; border-left-width: thin;
+ border-left-color: #7B68EE; padding-left:5 }
+th { font-weight: bold }
+
+a.command-link {
+}
+a.command-link img {
+ border-width: 0px;
+ border-style: none;
+ vertical-align: middle;
+}
\ No newline at end of file
Added: directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/about.png
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/about.png?view=auto&rev=499055
==============================================================================
Binary file - no diff available.
Propchange: directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/about.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/bug-report.png
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/bug-report.png?view=auto&rev=499055
==============================================================================
Binary file - no diff available.
Propchange: directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/bug-report.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/jira-screenshot.png
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/jira-screenshot.png?view=auto&rev=499055
==============================================================================
Binary file - no diff available.
Propchange: directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/jira-screenshot.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/manage-configuration.png
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/manage-configuration.png?view=auto&rev=499055
==============================================================================
Binary file - no diff available.
Propchange: directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/manage-configuration.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/search-updates.png
URL: http://svn.apache.org/viewvc/directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/search-updates.png?view=auto&rev=499055
==============================================================================
Binary file - no diff available.
Propchange: directory/ldapstudio/trunk/ldapstudio-rcp-help/resources/images/search-updates.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: 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=diff&rev=499055&r1=499054&r2=499055
==============================================================================
--- directory/ldapstudio/trunk/ldapstudio-rcp-help/src/main/resources/0_index.xml (original)
+++ directory/ldapstudio/trunk/ldapstudio-rcp-help/src/main/resources/0_index.xml Tue Jan 23 07:34:20 2007
@@ -10,16 +10,216 @@
</copyright>
<legalnotice>
<para>
- This user guide is distributed under the Apache License.
- </para>
+ This user's guide is distributed under the Apache License, Version 2.0.
+ You can find the license details online at <ulink url="http://apache.org/licenses/LICENSE-2.0.txt">http://apache.org/licenses/LICENSE-2.0.txt</ulink>.
+ </para>
</legalnotice>
</bookinfo>
- <!-- INTRODUCTION SECTION -->
- <section id="introduction">
- <title>Introduction</title>
- <para>
- LDAP Studio is a Tooling Platform for LDAP Servers. It composed of an Eclipse RCP Application and a set of Eclipse plugins.
- </para>
- </section>
+ <!-- GETTING STARTED CHAPTER -->
+ <chapter id="gettingstarted">
+ <title>Getting started</title>
+
+ <!-- DOWNLOAD AND INSTALLATION SECTION -->
+ <section id="download_install">
+ <title>Download and install</title>
+ <para>The latest version of LDAP Studio can be downloaded from the
+ LDAP Studio Downloads page, at this address :
+ <ulink url="http://people.apache.org/~pamarcelot/ldapstudio/downloads/">http://people.apache.org/~pamarcelot/ldapstudio/downloads/</ulink>.</para>
+ <para><emphasis role="strong">System requirements</emphasis></para>
+ <para>
+ <itemizedlist>
+ <listitem>Mac OS X 10.4 or later, Windows, Linux or Solaris</listitem>
+ <listitem><ulink url="http://www.java.com/">Java Runtime Environment</ulink> 5 or later</listitem>
+ </itemizedlist>
+ </para>
+ <para><emphasis role="strong">Installing on Mac OS X</emphasis></para>
+ <para>Follow this installation process:</para>
+ <para>
+ <itemizedlist>
+ <listitem>Step 1: Double-click the downloaded package to mount the LDAP Studio DMG.</listitem>
+ <listitem>Step 2: Drag and drop LDAP Studio to your Applications folder.</listitem>
+ </itemizedlist>
+ </para>
+ <para><emphasis role="strong">Installing on Linux</emphasis></para>
+ <para>Follow this installation process:</para>
+ <para>
+ <itemizedlist>
+ <listitem>Step 1: Uncompress the Tar Gzip archive ('tar xzf ldapstudio-0.6.0-linux-i386.tar.gz' for the i386 Linux version).</listitem>
+ <listitem>Step 2: Move the LDAP Studio folder to the location of your choice.</listitem>
+ </itemizedlist>
+ </para>
+ <para><emphasis role="strong">Installing on Windows</emphasis></para>
+ <para>Follow this installation process:</para>
+ <para>
+ <itemizedlist>
+ <listitem>Unzip the Zip archive.</listitem>
+ <listitem>Run the installer and follow install instructions.</listitem>
+ </itemizedlist>
+ </para>
+ <para><emphasis role="strong">Installing on Solaris</emphasis></para>
+ <para>TO DO</para>
+ </section>
+ </chapter>
+
+ <!-- TASKS CHAPTER -->
+ <chapter id="tasks">
+ <title>Tasks</title>
+
+ <!-- RUNNING LDAP STUDIO SECTION -->
+ <section id="running">
+ <title>Running LDAP Studio</title>
+ <para><emphasis role="strong">Mac OS X</emphasis></para>
+ <para>If you followed the instructions on the "Download and install" page, simply double-click the LDAP Studio application located in your Applications folder.</para>
+ <para><emphasis role="strong">Linux</emphasis></para>
+ <para>After installing the LDAP Studio in a directory, you can start LDAP Studio by running the LDAP Studio executable included with the release.</para>
+ <para><emphasis role="strong">Windows</emphasis></para>
+ <para>If you followed the instructions on the "Download and install" page, simply click on the LDAP Studio executable in the LDAP Studio folder located in the All programs item of the Start menu.</para>
+ <para><emphasis role="strong">Solaris</emphasis></para>
+ <para>TO DO</para>
+ </section>
+
+ <!-- UPDATING LDAP STUDIO SECTION -->
+ <section id="updating">
+ <title>Updating LDAP Studio</title>
+ <para>To check to see whether there are updates for features of LDAP Studio (requires Internet access):</para>
+ <para>1. Click <emphasis role="strong">Help > Software Updates > <imageobject><imagedata fileref="images/search-updates.png" format="PNG" /></imageobject> Search for updates...</emphasis>.
+ This will contact LDAP Studio Web site to discover what versions of those features are available. The potential
+ upgrades are presented in on the next page.</para>
+ <para>2. Select the feature versions that you wish to upgrade, and click <emphasis role="strong">Next</emphasis>.</para>
+ <para>3. Carefully review the license agreements for the upgraded features. If the terms of
+ all these licenses are acceptable, check "I accept the terms in the license agreements." Do not proceed to
+ download the features if the license terms are not acceptable.</para>
+ <para>4. Feature versions can be digitally signed by the company that provides them. This allows you to
+ verify more easily that the features and plug-ins that are about to be downloaded and installed are coming from
+ a trusted supplier.</para>
+ <para>Click <emphasis role="strong">Install</emphasis> to allow the downloading and installing to proceed.</para>
+ <para>5. Once all the features and plug-ins have been downloaded successfully and their files installed into the product on the
+ local computer, a new configuration that incorporates these features and plug-ins will be formulated. Click <emphasis role="strong">Yes</emphasis> when asked to exit
+ and restart the Workbench for the changes to take effect.</para>
+
+ <!-- INSPECTING THE CURRENT CONFIGURATION SECTION -->
+ <section id="inspecting_configuration">
+ <title>Inspecting the current configuration</title>
+ <para>The <emphasis role="strong">Help > <imageobject><imagedata fileref="images/about.png" format="PNG" /></imageobject> About LDAP Studio</emphasis> dialog shows most of the important information about the features and plug-in configured
+ in the product. To find out further detailed information about the current configuration:</para>
+ <para>1. Open the update configuration manager by clicking <emphasis role="strong"> Help > Software Updates > <imageobject><imagedata fileref="images/manage-configuration.png" format="PNG" /></imageobject> Manage Configuration</emphasis>.
+ This opens the Product Configuration dialog.</para>
+ <para>2. In the Product Configuration dialog expand the root node (current configuration). The first tier of items are locations on
+ the local computer where the files for features and plug-ins are stored. For a typical product, all features are installed in a single
+ directory sub-tree. However, a feature that is installed as an extension of another product are usually located in a separate directory
+ sub-tree.</para>
+ <para>3. Expand the location to see the feature versions installed there.</para>
+ <para>4. The nesting of the features indicates which child features are included in a given parent feature. Nested features act as a unit.
+ </para>
+ <para>5. Select a feature version and click <emphasis role="strong">Show Properties</emphasis> to open the Properties dialog which presents more detailed information about
+ the selected feature.</para>
+ <para>6. Click <emphasis role="strong">Show Disabled Features</emphasis> filter on the toolbar of the Product Configuration dialog. Any feature versions that are disabled are
+ now shown (you might not have any). Disabled feature versions are ones that are installed on the local computer but excluded from the
+ current configuration. At most one version of any given feature can be present in a given configuration; usually the ones with the lower
+ version numbers will be in a disabled state.</para>
+ <para>7. In the Properties dialog of a feature, click <emphasis role="strong">Status</emphasis> to find out whether the selected feature is configured exactly as packaged. The
+ status will show when a feature's plug-ins are present at different versions, or disabled due to missing prerequisite plug-ins that are
+ expected to be supplied by some other feature.</para>
+ </section>
+
+ <!-- ENABLING, DISABLING AND UNINSTALLING FEATURES SECTION -->
+ <section id="enabling_disabling_uninstalling_features">
+ <title>Enabling, disabling and uninstalling features</title>
+ <para>You can browse and manage your configuration from the <emphasis role="strong">Product Configuration dialog</emphasis>. Open the <emphasis role="strong">Product Configuration</emphasis> dialog by
+ clicking <emphasis role="strong"> Help > Software Updates > <imageobject><imagedata fileref="images/manage-configuration.png" format="PNG" /></imageobject> Manage Configuration</emphasis>.</para>
+ <para>1. <emphasis role="strong">Disabling a feature</emphasis>: select the feature and click <emphasis role="strong">Disable</emphasis> in the right pane of the dialog. This option is available only when the
+ feature is currently enabled, and the feature is either an optional feature or a root feature (not included by other features).</para>
+ <para>2. <emphasis role="strong">Enabling a feature</emphasis>: First, ensure <emphasis role="strong">Show Disabled Features</emphasis> is turned on in the tool bar. Then, select a disabled optional or root
+ feature and click <emphasis role="strong">Enable</emphasis> in the right pane of the dialog.</para>
+ <para>3. <emphasis role="strong">Uninstalling a feature</emphasis>: features that you have installed using the update manager can be uninstalled, provided they are already
+ disabled, or that they are optional or root features. If the feature is disabled, make sure <emphasis role="strong">Show Disabled Features</emphasis> is turned on in the tool bar.
+ Select the feature and click <emphasis role="strong">Uninstall</emphasis> in the right page of the dialog.</para>
+ </section>
+
+ </section>
+
+ <!-- REPORTING A BUG SECTION -->
+ <section id="reporting_a_bug">
+ <title>Reporting a bug</title>
+ <para>Use the <emphasis role="strong">Help > <imageobject><imagedata fileref="images/bug-report.png" format="PNG" /></imageobject> Report a bug...</emphasis> menu item to report any bug you find on LDAP Studio.</para>
+ <para>You will be redirected on your default Web browser to our issue tracking software called Jira.</para>
+ <para>You can also reach it using this address : <ulink url="https://issues.apache.org/jira/browse/DIRSTUDIO">https://issues.apache.org/jira/browse/DIRSTUDIO</ulink></para>
+ <para><imageobject><imagedata fileref="images/jira-screenshot.png" format="PNG" /></imageobject></para>
+ <para>To report a bug:</para>
+ <para>1. Click the <emphasis role="strong">Create a new issue</emphasis> link in the menu.</para>
+ <para>2. Make sure the selected project is 'Directory LDAP Studio' and the issue type is 'Bug'. Click <emphasis role="strong">Next</emphasis>.</para>
+ <para>3. Fill in the issue form giving the more details you can on the bug you have found.</para>
+ <para>4. Click the <emphasis role="strong">Create</emphasis> button to create the new issue.</para>
+ </section>
+
+ </chapter>
+
+ <!-- REFERENCE -->
+ <chapter id="reference">
+ <title>Reference</title>
+
+ <!-- PREFERENCES SECTION -->
+ <section id="preferences">
+ <title>Preferences</title>
+
+ <!-- HELP SECTION -->
+ <section id="help">
+ <title>Help</title>
+
+ <!-- HELP SERVER SECTION -->
+ <section id="help_server">
+ <title>Help Server</title>
+ </section>
+
+ </section> <!-- end Help Section -->
+
+ <!-- TEXT EDITORS SECTION -->
+ <section id="text_editors">
+ <title>Text editors</title>
+
+ <!-- ACCESSIBILITY SECTION -->
+ <section id="accessibility">
+ <title>Accessibility</title>
+ </section>
+
+ <!-- ANNOTATIONS SECTION -->
+ <section id="annotations">
+ <title>Annotations</title>
+ </section>
+
+ <!-- LINKED MODE SECTION -->
+ <section id="linked_mode">
+ <title>Linked mode</title>
+ </section>
+
+ <!-- QUICK DIFF SECTION -->
+ <section id="quick_diff">
+ <title>Quick diff</title>
+ </section>
+
+ <!-- SPELLING SECTION -->
+ <section id="spelling">
+ <title>Spelling</title>
+ </section>
+
+ </section> <!-- end Text Editors Section -->
+
+ </section> <!-- end Preferences Section -->
+
+ <!-- RELEASE NOTES SECTION -->
+ <section id="release_notes">
+ <title>Release notes</title>
+ <para><emphasis role="strong">LDAP Studio 0.6.0</emphasis> (2007, late january) : initial release</para>
+ <para>Includes :</para>
+ <para>
+ <itemizedlist spacing="normal" mark="bullet">
+ <listitem>LDAP Studio RCP 0.6.0</listitem>
+ <listitem>LDAP Studio Browser Plugin 0.6.0</listitem>
+ <listitem>LDAP Studio Schemas Editor Plugin 0.6.0</listitem>
+ </itemizedlist>
+ </para>
+ </section> <!-- end Release Notes Section -->
+
+ </chapter>
</book>