[Pkg-owncloud-commits] [owncloud-doc] 182/227: Clarify the documentation about the preview system a little bit more

Sat Oct 11 17:20:47 UTC 2014

This is an automated email from the git hooks/post-receive script.

taffit pushed a commit to branch master
in repository owncloud-doc.

commit 757b606ea55eb95cb6e5fad9db92f161e08b638a
Author: Lukas Reschke <lukas at owncloud.com>
Date:   Wed Oct 1 17:32:47 2014 +0200

    Clarify the documentation about the preview system a little bit more
    
    The security notice needs also to be in the 7.0.3 release notes.
---
 .../configuration/configuration_preview.rst        | 105 ++++++++-------------
 admin_manual/images/preview_images.png             | Bin 0 -> 37722 bytes
 2 files changed, 37 insertions(+), 68 deletions(-)

diff --git a/admin_manual/configuration/configuration_preview.rst b/admin_manual/configuration/configuration_preview.rst
index b57b178..cf553fa 100644
--- a/admin_manual/configuration/configuration_preview.rst
+++ b/admin_manual/configuration/configuration_preview.rst
@@ -1,56 +1,43 @@
 Preview Configuration
 =====================
-ownCloud 6 introduced the new thumbnail system. It is used to generate
-thumbnails from various file types.
-By default, it can generate previews for:
-
-* Images
-* Movies
-* Cover from mp3 files
-* various office files
-* Pdf
-* Svg
-* Text
-
-Soft dependencies:
-------------------
-
-imagick:
-~~~~~~~~
-ownCloud needs the imagick PHP extension to generate previews from office, PDF
-and SVG files. For further information on how to install the imagick PHP
-extension on your system take a look at the `PHP documentation <http://www.php.net/manual/en/imagick.installation.php>`_.
-If imagick is not installed, ownCloud will show file type icons instead of previews.
-
-LibreOffice / OpenOffice:
-~~~~~~~~~~~~~~~~~~~~~~~~~
-ownCloud comes with a php-only preview system for office files. But this
-preview system has limited capabilities and is only able to create previews
-from basic Microsoft Office files. If you need previews from advanced
-Microsoft Office files or OpenDocument files, you have to install LibreOffice
-or OpenOffice. To learn more about installing LibreOffice/OpenOffice consider
-your distribution's documentation.
-
-avconv / ffmpeg:
-~~~~~~~~~~~~~~~~
-ownCloud requires avconv of ffmpeg to generate previews from movies. To learn
-more about installing avconv or ffmpeg consider your distribution's
-documentation.
+ownCloud 6 introduced a new thumbnail system. It is used to generate
+thumbnails from various file types. Which are then shown as thumbnail 
+in the files application of the web interface or as larger preview for
+public shared links.
+
+In the following image can be seen a file (A) where the ownCloud server
+could generate a preview image and another file (B) where no preview 
+could be generated. In this case a generic icon depending on the filetype 
+is displayed.
+
+.. figure:: ../images/preview_images.png
+
+By default, ownCloud can generate previews for the following filetypes:
+
+* Images files
+* Cover of MP3 files
+* Text documents
+
+.. note:: Older versions of ownCloud also supported the preview generation
+          of other file types such as PDF, SVG or various office documents.
+          Due to security concerns those providers have been disabled by
+          default and are considered unsupported.
+          While those providers are still available, it is  discouraged to 
+          enable one of those providers. Therfore these providers are also
+          not documented.
 
 Parameters
 ----------
+Please notice that the ownCloud preview system comes already with sensible 
+defaults and therefore it is usually unecessary to adjust those configuration 
+values. 
+
 Disabling previews:
 ~~~~~~~~~~~~~~~~~~~
-Under certain circumstances like a big user base or limited resources you might
-want to consider disabling previews.
-
-.. code-block:: php
-
-  <?php
-    'enable_previews' => true,
-
-There is a config option called 'enable_previews'. By default it's set to true.
-You can disable previews by setting this option to false:
+Under certain circumstances, for example if the server has only very limited 
+resources, you might want to consider disabling the generation of previews. 
+This can be done by  setting the configuration option 'enable_previews' in 
+config.php to false:
 
 .. code-block:: php
 
@@ -70,7 +57,7 @@ There are two config options to set the maximum size of a preview.
 
 By default, both config options are set to null. 'Null' is equal to no limit.
 Numeric values represent the size in pixel. The following code limits previews
-to a maximum size of 100px by 100px:
+to a maximum size of 100×100px:
 
 .. code-block:: php
 
@@ -82,9 +69,9 @@ to a maximum size of 100px by 100px:
 
 Maximum scale factor:
 ~~~~~~~~~~~~~~~~~~~~~
-If you have a lot of small pictures and the preview system generates blurry
-previews, you might want to consider setting a maximum scale factor. By default,
-ownCloud scales pictures up to 10 times the original size:
+If a lot of small pictures are stored on the ownCloud instance and the preview 
+system generates blurry previews, you might want to consider setting a maximum 
+scale factor. By default, pictures are upscaled to 10 times the original size:
 
 .. code-block:: php
 
@@ -104,21 +91,3 @@ If you want to disable the maximum scaling factor, you can set the config value
 
   <?php
     'preview_max_scale_factor' => null,
-
-LibreOffice / OpenOffice:
-~~~~~~~~~~~~~~~~~~~~~~~~~
-You can set a custom path for the LibreOffice binary. If LibreOffice is not yet
-available on your system, you can also use OpenOffice instead.
-
-.. code-block:: php
-
-  <?php
-    'preview_libreoffice_path' => '/usr/bin/libreoffice',
-
-You can set custom LibreOffice / OpenOffice command line parameters by setting
-the preview_office_cl_parameters option.
-
-.. code-block:: php
-
-  <?php
-    'preview_office_cl_parameters' => ' ',
diff --git a/admin_manual/images/preview_images.png b/admin_manual/images/preview_images.png
new file mode 100644
index 0000000..6116b80
Binary files /dev/null and b/admin_manual/images/preview_images.png differ

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-owncloud/owncloud-doc.git

