diff options
author | Stefan Seelmann <mail@stefan-seelmann.de> | 2020-04-05 17:41:11 +0300 |
---|---|---|
committer | Stefan Seelmann <mail@stefan-seelmann.de> | 2020-04-05 17:41:11 +0300 |
commit | d84d44a7a558b45a1158ad1513e879f7c1493852 (patch) | |
tree | 4b1faf14510c31c8653b5b0e72d6fe95eaccee02 /helps | |
parent | bddc7e2e25f90048059d099030423c00db579c6f (diff) |
DIRSTUDIO-1124: Update basic LDAP server view doc
Diffstat (limited to 'helps')
-rw-r--r-- | helps/apacheds.help/src/main/docbook/0_index.xml | 2 | ||||
-rw-r--r-- | helps/apacheds.help/src/main/docbook/1.1_download_install.xml | 3 | ||||
-rw-r--r-- | helps/apacheds.help/src/main/docbook/1.2_ldap_servers_view.xml (renamed from helps/apacheds.help/src/main/docbook/1.2_servers_view.xml) | 101 | ||||
-rw-r--r-- | helps/apacheds.help/src/main/docbook/1_gettingstarted.xml | 2 | ||||
-rw-r--r-- | helps/apacheds.help/src/main/docbook/2.1_creating_new_server.xml | 18 | ||||
-rw-r--r-- | helps/apacheds.help/src/main/resources/html/images/icons_connection_add.gif | bin | 0 -> 585 bytes | |||
-rw-r--r-- | helps/apacheds.help/src/main/resources/html/images/tasks_new_server_wizard.png | bin | 12315 -> 28973 bytes | |||
-rw-r--r-- | helps/apacheds.help/src/main/resources/html/images/views_ldap_servers.png | bin | 0 -> 8503 bytes | |||
-rw-r--r-- | helps/apacheds.help/src/main/resources/html/images/views_servers-view.png | bin | 7577 -> 0 bytes |
9 files changed, 101 insertions, 25 deletions
diff --git a/helps/apacheds.help/src/main/docbook/0_index.xml b/helps/apacheds.help/src/main/docbook/0_index.xml index ef53b4980..8adf5c0e3 100644 --- a/helps/apacheds.help/src/main/docbook/0_index.xml +++ b/helps/apacheds.help/src/main/docbook/0_index.xml @@ -3,7 +3,7 @@ <!ENTITY gettingstarted SYSTEM "1_gettingstarted.xml"> <!ENTITY gettingstarted_download_install SYSTEM "1.1_download_install.xml"> - <!ENTITY gettingstarted_servers_view SYSTEM "1.2_servers_view.xml"> + <!ENTITY gettingstarted_ldap_servers_view SYSTEM "1.2_ldap_servers_view.xml"> <!ENTITY gettingstarted_configuration_editor SYSTEM "1.3_configuration_editor.xml"> <!ENTITY gettingstarted_configuration_editor_overview SYSTEM "1.3.1_configuration_editor_overview.xml"> <!ENTITY gettingstarted_configuration_editor_ldap_server SYSTEM "1.3.2_configuration_editor_ldap_server.xml"> diff --git a/helps/apacheds.help/src/main/docbook/1.1_download_install.xml b/helps/apacheds.help/src/main/docbook/1.1_download_install.xml index d8e162820..39e77cbbd 100644 --- a/helps/apacheds.help/src/main/docbook/1.1_download_install.xml +++ b/helps/apacheds.help/src/main/docbook/1.1_download_install.xml @@ -20,8 +20,7 @@ <title>Download and installation</title> <para> The latest version of Apache Directory Studio can be downloaded - from the Apache Directory Studio Downloads page, at this address - : + from the Apache Directory Studio Downloads page, at this address: <ulink url="https://directory.apache.org/studio/downloads.html"> https://directory.apache.org/studio/downloads.html diff --git a/helps/apacheds.help/src/main/docbook/1.2_servers_view.xml b/helps/apacheds.help/src/main/docbook/1.2_ldap_servers_view.xml index 4f7f82dc3..593e982c1 100644 --- a/helps/apacheds.help/src/main/docbook/1.2_servers_view.xml +++ b/helps/apacheds.help/src/main/docbook/1.2_ldap_servers_view.xml @@ -16,39 +16,41 @@ specific language governing permissions and limitations under the License. --> -<section id="gettingstarted_servers_view"> +<section id="gettingstarted_ldapservers_view"> <title>LDAP Servers View</title> <para> - The Servers view allows you to manage the servers. This view + The LDAP Servers view allows you to manage the servers. This view displays a list of all your servers. You can use this view to start or stop the servers. </para> <para> - Here is what the Servers view looks like: + Here is an example screenshot of the LDAP Servers view: <screenshot> <mediaobject> - <imageobject> + j<imageobject> <imagedata scale="50" - fileref="images/views_servers-view.png" + fileref="images/views_ldap_servers.png" format="PNG" /> </imageobject> </mediaobject> </screenshot> </para> <para> - Use the Servers view to perform the following tasks: + Use the LDAP Servers view to perform the following tasks: <itemizedlist spacing="normal" mark="bullet"> <listitem>Create a server</listitem> - <listitem>Edit a server</listitem> - <listitem>Delete a server</listitem> + <listitem>Rename a server</listitem> + <listitem>Configure a server</listitem> <listitem>Start a server</listitem> + <listitem>Create a connection to the server</listitem> <listitem>Stop a server</listitem> + <listitem>Delete a server</listitem> </itemizedlist> </para> <para> - The Servers view displays the current status of all the servers. + The LDAP Servers view displays the current status of all the servers. The - <emphasis role="strong">Status</emphasis> + <emphasis role="strong">State</emphasis> column indicates whether or not a server has been started. The following lists the possible server status: <itemizedlist spacing="normal" mark="bullet"> @@ -62,7 +64,42 @@ <emphasis role="strong">Toolbar</emphasis> </para> <para> - The toolbar of the Servers view contains the following actions: + The toolbar of the LDAP Servers view contains the following actions: + <itemizedlist spacing="normal" mark="bullet"> + <listitem> + <imageobject> + <imagedata scale="50" + fileref="images/icons_server_new.gif" format="GIF" /> + </imageobject> + - + <emphasis>New server</emphasis> + : Creates a new LDAP server. + </listitem> + <listitem> + <imageobject> + <imagedata scale="50" + fileref="images/icons_run.gif" format="GIF" /> + </imageobject> + - + <emphasis>Run</emphasis> + : Starts the selected LDAP server. + </listitem> + <listitem> + <imageobject> + <imagedata scale="50" + fileref="images/icons_stop.gif" format="GIF" /> + </imageobject> + - + <emphasis>Stop</emphasis> + : Stops the selected LDAP server. + </listitem> + </itemizedlist> + </para> + <para> + <emphasis role="strong">Context Menu</emphasis> + </para> + <para> + The context menu of the LDAP Servers view contains the following actions: <itemizedlist spacing="normal" mark="bullet"> <listitem> <imageobject> @@ -70,8 +107,25 @@ fileref="images/icons_server_new.gif" format="GIF" /> </imageobject> - - <emphasis>Create a new server</emphasis> - : Creates a new server. + <emphasis>New Server</emphasis> + : Creates a new LDAP server. + </listitem> + <listitem> + <emphasis>Open Configuration</emphasis> + : Opens the configuration editor. + </listitem> + <listitem> + <imageobject> + <imagedata scale="50" + fileref="images/icons_delete.gif" format="GIF" /> + </imageobject> + - + <emphasis>Delete</emphasis> + : Deletes the selected LDAP server. + </listitem> + <listitem> + <emphasis>Rename...</emphasis> + : Renames the selected LDAP server. </listitem> <listitem> <imageobject> @@ -80,7 +134,7 @@ </imageobject> - <emphasis>Run</emphasis> - : Starts the selected server. + : Starts the selected LDAP server. </listitem> <listitem> <imageobject> @@ -89,14 +143,29 @@ </imageobject> - <emphasis>Stop</emphasis> - : Stops the selected server. + : Stops the selected LDAP server. + </listitem> + <listitem> + <imageobject> + <imagedata scale="50" + fileref="images/icons_connection_add.gif" format="GIF" /> + </imageobject> + - + <emphasis>Create a Connection</emphasis> + : Creates a preconfigured connection to the selected LDAP server. + </listitem> + <listitem> + <emphasis>Properties</emphasis> + : Opens the properties dialog of the selected LDAP server which shows details like version and the path the to configuration folder. </listitem> </itemizedlist> </para> + + <para> <emphasis role="strong">Icons</emphasis> </para> - <para>The following icons can appear in the Hierarchy view:</para> + <para>The following icons can appear in the LDAP Servers view:</para> <para> <informaltable> <tgroup cols="2"> diff --git a/helps/apacheds.help/src/main/docbook/1_gettingstarted.xml b/helps/apacheds.help/src/main/docbook/1_gettingstarted.xml index 064d55c37..48652f4ed 100644 --- a/helps/apacheds.help/src/main/docbook/1_gettingstarted.xml +++ b/helps/apacheds.help/src/main/docbook/1_gettingstarted.xml @@ -24,7 +24,7 @@ </para> &gettingstarted_download_install; - &gettingstarted_servers_view; + &gettingstarted_ldap_servers_view; &gettingstarted_configuration_editor; </chapter>
\ No newline at end of file diff --git a/helps/apacheds.help/src/main/docbook/2.1_creating_new_server.xml b/helps/apacheds.help/src/main/docbook/2.1_creating_new_server.xml index 81b2bf774..b71255505 100644 --- a/helps/apacheds.help/src/main/docbook/2.1_creating_new_server.xml +++ b/helps/apacheds.help/src/main/docbook/2.1_creating_new_server.xml @@ -17,9 +17,9 @@ under the License. --> <section id="tasks_creating_new_server"> - <title>Creating a new server</title> + <title>Creating a new LDAP server</title> <para> - To create a new server, in the Servers view toolbar, click on + To create a new LDAP server, in the Servers view toolbar, click on the <imageobject> <imagedata scale="50" @@ -57,10 +57,18 @@ </thead> <tbody> <row> - <entry>Name</entry> + <entry>Server Type</entry> <entry> - The name of the server. In the Servers view - the server is listed with this name. The + The type of the LDAP server. Currently only the + Apache Directory Server (ApacheDS) is available. + </entry> + <entry>empty</entry> + </row> + <row> + <entry>Server Name</entry> + <entry> + The name of the LDAP server. In the LDAP Servers + view the server is listed with this name. The name must be unique. </entry> <entry>empty</entry> diff --git a/helps/apacheds.help/src/main/resources/html/images/icons_connection_add.gif b/helps/apacheds.help/src/main/resources/html/images/icons_connection_add.gif Binary files differnew file mode 100644 index 000000000..ea1b9c619 --- /dev/null +++ b/helps/apacheds.help/src/main/resources/html/images/icons_connection_add.gif diff --git a/helps/apacheds.help/src/main/resources/html/images/tasks_new_server_wizard.png b/helps/apacheds.help/src/main/resources/html/images/tasks_new_server_wizard.png Binary files differindex 0ced85ce2..172a2f83c 100644 --- a/helps/apacheds.help/src/main/resources/html/images/tasks_new_server_wizard.png +++ b/helps/apacheds.help/src/main/resources/html/images/tasks_new_server_wizard.png diff --git a/helps/apacheds.help/src/main/resources/html/images/views_ldap_servers.png b/helps/apacheds.help/src/main/resources/html/images/views_ldap_servers.png Binary files differnew file mode 100644 index 000000000..65d1d4c7d --- /dev/null +++ b/helps/apacheds.help/src/main/resources/html/images/views_ldap_servers.png diff --git a/helps/apacheds.help/src/main/resources/html/images/views_servers-view.png b/helps/apacheds.help/src/main/resources/html/images/views_servers-view.png Binary files differdeleted file mode 100644 index c56d3e841..000000000 --- a/helps/apacheds.help/src/main/resources/html/images/views_servers-view.png +++ /dev/null |