Merge pull request #14 from imCodePartnerAB/IA_doc

IA documentation

docs/image-archive/server.rst

@@ -16,136 +16,151 @@ Server Configuration
 
 To set up Image Archive server we have application container:
 
-    `https://svn.imcode.com/imcode/customers/imagearchive/trunk`
+`https://svn.imcode.com/imcode/customers/imagearchive/trunk`
 
 Set it up with next properties:
 
-    * Database configuration:
+* Database configuration:
+
+   For SQL Server
 
-        For SQL Server
 .. code-block:: properties
 
         jdbc-driver = net.sourceforge.jtds.jdbc.Driver
-
         jdbc-url = jdbc:jtds:sqlserver://localhost:1433/;AppName=imCMS;DatabaseName=imcms
-
         hibernate-dialect = com.imcode.imcms.addon.imagearchive.util.SQLServerDialect
 
 
-        For MySQL
+   For MySQL
+
 .. code-block:: properties
 
         jdbc-driver = com.mysql.jdbc.Driver
-
         jdbc-url = jdbc:mysql://localhost:3306/iarch_new?characterEncoding=utf8
-
         hibernate-dialect = org.hibernate.dialect.MySQL5InnoDBDialect
 
-        jdbc-username =
 
+   For both:
+
+.. code-block:: properties
+
+        jdbc-username =
         jdbc-password =
 
 
-    * Hibernate configuration
+* Hibernate configuration
+
+   Automatically validates or exports schema DDL to the database when the ``SessionFactory`` is created.
 
-        Automatically validates or exports schema DDL to the database when the ``SessionFactory`` is created.
 .. code-block:: properties
 
         hibernate-hbm2ddl-auto =
 
 
-        Possible values:
+   Possible values:
 
-            - **validate**: validate that the schema matches, make no changes to the schema of the database, you probably want this for production
+   - **validate**: validate that the schema matches, make no changes to the schema of the database, you probably want this for production
 
-            - **update**: update the schema to reflect the entities being persisted
+   - **update**: update the schema to reflect the entities being persisted
 
-            - **create**: creates the schema necessary for your entities, destroying any previous data
+   - **create**: creates the schema necessary for your entities, destroying any previous data
 
-            - **create-drop**: create the schema as in create above, but also drop the schema at the end of the session. This is great in early development or for testing.
+   - **create-drop**: create the schema as in create above, but also drop the schema at the end of the session. This is great in early development or for testing.
 
-    * Image Archive own configuration
+* Image Archive own configuration
 
-        URL to imCMS application that makes use of this Image Archive, as seen by the clients browser, in form:
+   URL to imCMS application that makes use of this Image Archive, as seen by the clients browser, in form:
 
-        **<host> [":" <port>] "/" <context-path>**
+   **<host> [":" <port>] "/" <context-path>**
+
+   For example: ``test.com/imcms`` or ``http://localhost:8080/skurup``
 
-        For example: ``test.com/imcms`` or ``http://localhost:8080/skurup``
 .. code-block:: properties
 
         imcms-root-url =
 
 
-        Path where all the images that are uploaded to Image Archive will be stored, can be relative or absolute.
+   Path where all the images that are uploaded to Image Archive will be stored, can be relative or absolute.
+
+   For example: ``/var/image_archive``
 
-        For example: ``/var/image_archive``
+   **! Be sure that user have rights to change folder content !**
 
-        **! Be sure that user have rights to change folder content !**
 .. code-block:: properties
 
         storage-path =
 
 
-        Path where temporary images that are being processed are stored.
+   Path where temporary images that are being processed are stored.
+
+   For example: ``/tmp`` or ``C:/tmp``
 
-        For example: ``/tmp`` or ``C:/tmp``
+   **! Be sure that user have rights to change folder content !**
 
-        **! Be sure that user have rights to change folder content !**
 .. code-block:: properties
 
         temp-path =
 
 
-        ImageMagick is a software suite for creating, editing and composing images. It can be downloaded from http://www.imagemagick.org. This path should lead to where ImageMagick is installed, and is required only on windows. For linux leave it empty.
-        For example: ``C:/program files/imagemagick-6.4.9-q16``
+   ImageMagick is a software suite for creating, editing and composing images. It can be downloaded from http://www.imagemagick.org. This path should lead to where ImageMagick is installed, and is required only on windows. For linux leave it empty.
+
+   For example: ``C:/program files/imagemagick-6.4.9-q16``
+
 .. code-block:: properties
 
         image-magick-path =
 
 
-        Maximum size of an uploaded image in bytes. By default 250 MB.
+   Maximum size of an uploaded image in bytes. By default 250 MB.
+
 .. code-block:: properties
 
         max-image-upload-size = 262144000
 
 
-        Maximum size of an uploaded ZIP archive in bytes. By default 250 MB.
+   Maximum size of an uploaded ZIP archive in bytes. By default 250 MB.
+
 .. code-block:: properties
 
         max-zip-upload-size = 262144000
 
 
-        URL path to login, in imCMS, relative to context path.
+   URL path to login, in imCMS, relative to context path.
+
 .. code-block:: properties
 
         imcms-login-url-path = login
 
 
-        Name for a directory within libraries folder, that will contain each users personal library.
-        This directory will be automatically created.
+   Name for a directory within libraries folder, that will contain each users personal library.
+   This directory will be automatically created.
+
 .. code-block:: properties
 
         imcms-users-library-folder = users
 
 
-        Images from Image Archive that are being used by imCMS will be stored here, can be relative or absolute.
+   Images from Image Archive that are being used by imCMS will be stored here, can be relative or absolute.
+
 .. code-block:: properties
 
         imcms-images-path =
 
 
-        Next two properties may be empty:
+   Next two properties may be empty:
+
+   Path to libraries, can be relative or absolute. Each folder in this directory will become a library in Image
+   Archive - these folders can be created using imCMS file manager. Each library can contain one or more raw images
+   which can be activated in Image Archive.
 
-        Path to libraries, can be relative or absolute. Each folder in this directory will become a library in Image
-        Archive - these folders can be created using imCMS file manager. Each library can contain one or more raw images
-        which can be activated in Image Archive.
 .. code-block:: properties
 
         imcms-libraries-path =
 
 
-        Absolute or relative paths separated by ";". Each path will become a library in Image archive, can be used for
-        gaining access to old Image Archive.
+   Absolute or relative paths separated by ";". Each path will become a library in Image archive, can be used for
+   gaining access to old Image Archive.
+
 .. code-block:: properties
 
         imcms-old-library-paths =