Pass on plugin_doc files (until action.updater), added some screenshots

cdujeu · cdujeu · commit efa65f9855cc · 2016-10-10T11:56:57.000+02:00
diff --git a/core/src/plugins/access.ajxp_home/ajxp_home.png b/core/src/plugins/access.ajxp_home/ajxp_home.png
diff --git a/core/src/plugins/access.ajxp_home/plugin_doc.html b/core/src/plugins/access.ajxp_home/plugin_doc.html
@@ -1 +1,6 @@
-<p>The "Shared Elements" repository uses this driver to display, and modify the metadata generated by all the share actions : shared files ("publiclets"), shared folders ("delegated repositories"), and shared users. Like access.ajxp_conf, it's a good demonstration of how Pydio can be used to browse data other than filesystem.</p>
+    <p>
+        This driver is used to serve the "Welcome Page" with workspaces lists, tuto and links to mobile apps.
+    </p>
+    <p style="text-align: center">
+        <img src="ajxp_home.png">
+    </p>
diff --git a/core/src/plugins/access.ajxp_user/ajxp_user.png b/core/src/plugins/access.ajxp_user/ajxp_user.png
diff --git a/core/src/plugins/access.ajxp_user/plugin_doc.html b/core/src/plugins/access.ajxp_user/plugin_doc.html
@@ -1 +1,10 @@
-<p>The "Shared Elements" repository uses this driver to display, and modify the metadata generated by all the share actions : shared files ("publiclets"), shared folders ("delegated repositories"), and shared users. Like access.ajxp_conf, it's a good demonstration of how Pydio can be used to browse data other than filesystem.</p>
+    <p>
+        This driver is used to serve the "My Account" panel. It provides a way to edit user profile and adress book by default, and
+        has some component hooks to display more preferences panels contributed by various plugins (WebDAV preferences, API Keys, etc).
+    </p>
+    <p>
+        Like access.ajxp_conf, it's a good demonstration of how Pydio can be used to browse data other than filesystem.
+    </p>
+    <p style="text-align: center">
+        <img src="ajxp_user.png">
+    </p>
diff --git a/core/src/plugins/access.demo/plugin_doc.html b/core/src/plugins/access.demo/plugin_doc.html
@@ -1 +1,4 @@
-<p>The demo driver extends the access.fs driver and return an error on any "write" actions. It's used essentially on Pydio.info demo website. We could give the demo user only "read" access to the demo repository, but using this driver allows to demonstrate more features, even if they are disabled.</p>
+    <p>
+        The demo driver extends the access.fs driver and return an error on any "write" actions. It's used essentially on Pydio.info demo website.
+        We could give the demo user only "read" access to the demo repository, but using this driver allows to demonstrate more features, even if they are disabled.
+    </p>
diff --git a/core/src/plugins/access.dropbox/access_dropbox.png b/core/src/plugins/access.dropbox/access_dropbox.png
diff --git a/core/src/plugins/access.dropbox/plugin_doc.html b/core/src/plugins/access.dropbox/plugin_doc.html
@@ -1,2 +1,12 @@
-<p>The Dropbox plugin is still experimental, and shall be used to access a dropbox account via their API. To use it, you must first register as Dropbox developer to get your API Key. This is typically a driver with wich you create a Repository Template, leaving the users credential empty and filling only your API Key info : that way, the users are able to access their own DropBox account without the administrator having to know their credentials, but using a shared API Key. See the documentation about the Repository Templates.</p>
-<p>Pear::Http_OAuth package must also be installed on your server in order to make the connection.</p>
+    <p>
+        The Dropbox plugin can be used to access a dropbox account via API. To use it, you must first register as Dropbox developer to get your API Key.
+    </p>
+    <p>
+        This is typically a driver with wich you create a Repository Template, leaving the users credential empty and filling only your API Key info : that way, the users are able to access their own DropBox account without the administrator having to know their credentials, but using a shared API Key. See the documentation about the Repository Templates.
+    </p>
+    <p style="text-align: center">
+        <img src="access_dropbox.png">
+    </p>
+    <p>
+        In Pydio v6, Pear::Http_OAuth package was required. It is not anymore in v7 and following.
+    </p>
diff --git a/core/src/plugins/access.ftp/plugin_doc.html b/core/src/plugins/access.ftp/plugin_doc.html
@@ -1,4 +1,4 @@
 <p><b>Disclaimer:</b> If you installed Pydio by the linux repository ( apt / yum ), you must install the "pydio-plugin-access.ftp" package.</p>
 <p>Use Pydio server as proxy to a remote FTP server. If the filesystem you want to browse is not locally accessible by the server and you can access it via FTP, use this driver for browsing the data. The user/password used to authenticate against the FTP server can be set in various ways, either using one credential for all users, or setting each users credentials, or even using the ftp server as the credential provider.</p>
 <p>The plugin can be linked to the <b>auth.ftp</b> to transform Pydio into a fully-feature generic FTP client, allowing your users to log in to any ftp server they want. See auth.ftp for more info.</p>
-<p>If you have the right accesses, you should also consider the plugin access.sftp, that uses SSH access to browse a server. It can be an interesting solution when you are struggling with permissions problems.</p>
+<p>If you have enough accesses, you should also consider the plugin access.sftp, that uses SSH access to browse a server. It can be an interesting solution when you are struggling with permissions problems.</p>
diff --git a/core/src/plugins/access.inbox/plugin_doc.html b/core/src/plugins/access.inbox/plugin_doc.html
@@ -0,0 +1,7 @@
+<p>
+    This plugin is used for the "Shared Files" page. It is presenting to the user a collection of all files that have been
+    shared with them.
+</p>
+<p>
+    Files can be either shared by a local user, or by a remote user through Federated Sharing.
+</p>
diff --git a/core/src/plugins/access.s3/plugin_doc.html b/core/src/plugins/access.s3/plugin_doc.html
@@ -1,9 +1,9 @@
-<p><b>Disclaimer:</b> If you installed Pydio by the linux repository ( apt / yum ), you must install the "pydio-plugin-access.s3" adn the "pydio-plugin-metastore.s3" package before.</p>
-<p>Use Amazon Simple Storage S3 as a file container. This extension requires the following to be installed :
-<ul>
-    <li>PHP cURL extension</li>
-    <li>PHP OpenSSL extension</li>
-    <li>Amazon PHP Sdk V2 or V3 : just drop the aws.phar inside the plugin folder</li>
-</ul>
-        Once all this is installed, you should be able to access an S3 storage, using the API keys provided on your Amazon console.
+<p>
+    <b>Disclaimer:</b> If you installed Pydio by the linux repository ( apt / yum ), you must install the "pydio-plugin-access.s3" adn the "pydio-plugin-metastore.s3" package before.
+</p>
+<p>Use Amazon Simple Storage S3 as a file container. This extension should work out-of-the-box in Pydio 7, as we package
+    the AWS SDK for PHP v3 directly.
+</p>
+<p>
+    To be able to access an S3 storage, you will have to use the API keys provided on your Amazon console.
 </p>
diff --git a/core/src/plugins/access.smb/plugin_doc.html b/core/src/plugins/access.smb/plugin_doc.html
@@ -1,3 +1,16 @@
-<p>Connect a Samba share and browse its files and folders. This plugin is based on a php wrapper around the command line tool <b>smbclient</b>. This tool must be installed on the server and accessible in the machine path. If you want to manually set the path to the <b>smbclient</b> program, edit the plugin global configuration. Interestingly, there is a working alternative of smbclient installable on Windows, using Cygwin. See the detailed instructions <a href="http://www.citricity.com/moodlegpl/windowssharewebclient/instructions_for_installing_smbclient32_on_windows.pdf">here</a>. But for a better result please use smbclient 3.0.23c <a href="http://smithii.com/samba">here</a>. In that case, you may have to enter the full path to the smbclient via the plugin configuration.</p>
-<p>For a repository, a typical configuration can be <ul><li>Host : <b>192.168.0.25</b></li><li>Uri : <b>Share</b></li></ul>If you encounter problems with "empty listing", check the ajaxplorer logs, and particularly set the server into debug mode : errors grabbed from the smbclient output are logged to the log file, not to the GUI, as sometimes it contains errors but sometimes it contains just warning or even info.</p>
-<p>Like the ftp access driver with the auth.ftp, this smb driver can be used in conjunction with the auth.smb plugin to authenticate users directly against the samba share. </p><p>The SMB wrapper was first developped by Victor M. Varela.</p>
+<p>Connect a Samba share and browse its files and folders. This plugin is based on a php wrapper around the command line
+    tool <b>smbclient</b>. This tool must be installed on the server and accessible in the machine path. If you want to
+    manually set the path to the <b>smbclient</b> program, edit the plugin global configuration. Interestingly, there is
+    a working alternative of smbclient installable on Windows, using Cygwin. See the detailed instructions <a
+            href="http://www.citricity.com/moodlegpl/windowssharewebclient/instructions_for_installing_smbclient32_on_windows.pdf">here</a>.
+    But for a better result please use smbclient 3.0.23c <a href="http://smithii.com/samba">here</a>. In that case, you
+    may have to enter the full path to the smbclient via the plugin configuration.</p>
+<p>For a repository, a typical configuration can be
+<ul>
+    <li>Host : <b>192.168.0.25</b></li>
+    <li>Uri : <b>Share</b></li>
+</ul>
+If you encounter problems with "empty listing", check the server logs, and particularly set the server into debug mode : errors grabbed from the smbclient output are logged to the log file, not to the GUI, as sometimes it contains errors but sometimes it contains just warning or even info.</p>
+<p>Like the ftp access driver with the auth.ftp, this smb driver can be used in conjunction with the auth.smb plugin to
+    authenticate users directly against the samba share. </p>
+<p>The SMB wrapper was first developped by Victor M. Varela.</p>
diff --git a/core/src/plugins/access.webdav/plugin_doc.html b/core/src/plugins/access.webdav/plugin_doc.html
@@ -1,6 +1,7 @@
-<p>Browse a remote WebDAV server. To be able to use the access.webdav driver, you must make sure that you have PEAR installed, and the
-latest HTTP_WebDAV_Client package installed ( https://pear.php.net/package/HTTP_WebDAV_Client, version 1.0.1 ).
-Then you have to patch the PEAR class HTTP/WebDAV/Client/Stream.php with the patch file contained in this plugin (PEAR_HTTP_WebDAV_Client_Path.diff).
+<p>
+    Create a workspace that stores/browse document inside/from a remote WebDAV server.
 </p>
-<p>Please not that this Webdav client only support "Basic" Http authentication, not "Digest", so make sure your
-server is using this kind of authentication.</p>
+<p>
+    Please not that this Webdav client only support "Basic" Http authentication, not "Digest", so make sure your
+server is using this kind of authentication.
+</p>
diff --git a/core/src/plugins/action.antivirus/plugin_doc.html b/core/src/plugins/action.antivirus/plugin_doc.html
@@ -1,4 +1,4 @@
-<p>Main objective of the plug-in is to implement an antivirus program into Pydio. All antivirus with command line interface should work. One of the advantages of this solution is that the antivirus program is separate from Pydio therefore there are no dependency issues. Another advantage is that you are free to configure Pydio and your antivirus program as you wish. The plug-in uses the PHP CLI to pass system commands. You can setup the antivirus command via the configuration editor which is accessible under the parameter/setting/plug-in/action/antivirus. Enter the command and use the $FILE variable to specify the path to where files will be scanned. This command will be called when each file is uploaded.</p>
+<p>Main objective of the plug-in is to implement an antivirus program into Pydio. All antivirus with command line interface should work. One of the advantages of this solution is that the antivirus program is separate from Pydio therefore there are no dependency issues. Another advantage is that you are free to configure Pydio and your antivirus program as you wish. The plug-in uses the PHP Command-line interface to pass system commands. You can setup the antivirus command via the configuration editor which is accessible under the parameter/setting/plug-in/action/antivirus. Enter the command and use the $FILE variable to specify the path to where files will be scanned. This command will be called when each file is uploaded.</p>
 <p>You can also set which file extensions should be scanned or not to scanned.  In the area “file extension to scan” enter the file extension to scan. This will result in only specified file extensions in the list will be scanned and all others to be ignored. Note! Typing */, at the beginning of the list will scan all files except for file extensions which are included after */.  For example “*/ .sh .zip; all files will be scanned except for files with the following extensions .sh and .zip. The last parameter is “max file size”. All files exceeding this size will not be scanned.<p>
 <p>An option exists to keep a trace file for all files which are yet to be scanned. The option is located in the “Generate a trace file not scanned”. First you must specify a folder (with write access rights for your web server).  If the trace option is enabling, a file will be created in this folder for each file which has not been scanned.  Each trace file will contain an entry with the absolute path of the file which has not been scanned.</p>
 
diff --git a/core/src/plugins/action.avatar/plugin_doc.html b/core/src/plugins/action.avatar/plugin_doc.html
@@ -1 +1 @@
-<p>Get user avatar from Gravatar, based on email address.</p>
+<p>Load user avatar from Gravatar or Libravatar webservices, based on email address.</p>
diff --git a/core/src/plugins/action.cart/carts.png b/core/src/plugins/action.cart/carts.png
diff --git a/core/src/plugins/action.compression/plugin_doc.html b/core/src/plugins/action.compression/plugin_doc.html
@@ -1,4 +1,3 @@
 <p>This plugin allows you to compress and extract tar, tar.gz and tar.bz2 archives.</p>
-<p>When enabled, he replaces the built-in compress system of Pydio</p>
-<p>You need to have, at least, version <b>5.3.0</b> of PHP to use this plugin.</p>
+<p>When enabled, it will enrich the built-in compression system of Pydio (zip only)</p>
 <p>If you want to archive files with special character like accents, we strongly recommend you to check your server's encoding</p>
diff --git a/core/src/plugins/action.powerfs/plugin_doc.html b/core/src/plugins/action.powerfs/plugin_doc.html
@@ -1 +1,2 @@
-<p>This plugin will delegate various time/memory-consuming actions to the underlying filesystem. <br><br>For the moment only the <b>ZIP delegation</b> is implemented. It requires the presence of the "zip" utilitary in the system path. Tested on both Linux and windows. If active, the "compress" action, as well as the "download folder" action, will trigger a background action monitoring the current percent of the ZIP operation. This allows the compression of huge amount of data.
+<p>This plugin will delegate the time-consuming "Zip" action to the underlying OS command.</p>
+<p>It requires the presence of the "zip" utilitary in the system path. Tested on both Linux and windows. If active, the "compress" action, as well as the "download folder" action, will trigger a background action monitoring the current percent of the ZIP operation. This allows the compression of huge amount of data.</p>
diff --git a/core/src/plugins/action.updater/plugin_doc.html b/core/src/plugins/action.updater/plugin_doc.html
@@ -1 +1,8 @@
-<p>Since v3.3.3, the plugin provide a full automatic upgrade feature, as well as an import tool to migrate v3.2.4 to v3.3.3, as the structure and the plugins configurations changed consequently. To make this latter tool appear, you have to edit the plugin options and enable it.</p>
+<p>Automatic in-app upgrade system.</p>
+<p>
+    This plugin provides the mechanism for automatically updating archive-based installation of Pydio. Linux packages installation (RPM / DEB) are not
+    covered by this system.
+</p>
+<p>
+    Plugin will request Pydio's official update sites to detect new version of server code and eventually download the upgrade package and apply changes.
+</p>
