Update info comments in all plugins

17 files changed, 147 insertions, 27 deletions

diff --git a/addon/calc/calc.php b/addon/calc/calc.php
index a095e3960..8c079dc7a 100644
--- a/addon/calc/calc.php
+++ b/addon/calc/calc.php
@@ -1,4 +1,11 @@
 <?php

+/**

+ * Name: Calculator App

+ * Description: Simple Calculator Application

+ * Version: 1.0

+ * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>

+ */

+

 

 function calc_install() {

 	register_hook('app_menu', 'addon/calc/calc.php', 'calc_app_menu');

diff --git a/addon/convert/convert.php b/addon/convert/convert.php
index a3448ce01..7a4c90a53 100644
--- a/addon/convert/convert.php
+++ b/addon/convert/convert.php
@@ -1,5 +1,10 @@
 <?php

-

+/**

+ * Name: Converter App

+ * Description: Unit converter application

+ * Version: 1.0

+ * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>

+ */

 

 function convert_install() {

 	register_hook('app_menu', 'addon/convert/convert.php', 'convert_app_menu');

diff --git a/addon/facebook/README b/addon/facebook/README
new file mode 100644
index 000000000..42ec01383
--- /dev/null
+++ b/addon/facebook/README
@@ -0,0 +1,33 @@
+Installing the Friendika/Facebook connector
+
+1. register an API key for your site from developer.facebook.com
+  a. We'd be very happy if you include "Friendika" in the application name
+     to increase name recognition. The Friendika icons are also present
+     in the images directory and may be uploaded as a Facebook app icon.
+     Use images/friendika-16.jpg for the Icon and images/friendika-128.jpg for the Logo.
+  b. The url should be your site URL with a trailing slash.
+     You may use http://portal.friendika.com/privacy as the privacy policy
+     URL unless your site has different requirements, and 
+     http://portal.friendika.com as the Terms of Service URL unless
+     you have different requirements. (Friendika is a software application
+     and does not require Terms of Service, though your installation of it might).
+  c. Set the following values in your .htconfig.php file
+        $a->config['facebook']['appid'] = 'xxxxxxxxxxx';
+        $a->config['facebook']['appsecret'] = 'xxxxxxxxxxxxxxx';
+     Replace with the settings Facebook gives you.
+2. Enable the facebook plugin by including it in .htconfig.php - e.g. 
+    $a->config['system']['addon'] = 'plugin1,plugin2,facebook';
+3. Visit the Facebook Settings section of the "Settings->Plugin Settings" page.
+   and click 'Install Facebook Connector'.
+4. This will ask you to login to Facebook and grant permission to the 
+   plugin to do its stuff. Allow it to do so. 
+5. You're done. To turn it off visit the Plugin Settings page again and
+   'Remove Facebook posting'.
+
+Vidoes and embeds will not be posted if there is no other content. Links 
+and images will be converted to a format suitable for the Facebook API and 
+long posts truncated - with a link to view the full post. 
+
+Facebook contacts will not be able to view private photos, as they are not able to
+authenticate to your site to establish identity. We will address this 
+in a future release.
diff --git a/addon/facebook/facebook.php b/addon/facebook/facebook.php
index 545779cd5..5d86c66c2 100644
--- a/addon/facebook/facebook.php
+++ b/addon/facebook/facebook.php
@@ -1,4 +1,9 @@
 <?php
+/**
+ * Name: Facebook Connector
+ * Version: 1.0
+ * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
+ */
 
 /**
  * Installing the Friendika/Facebook connector
diff --git a/addon/fortunate/fortunate.php b/addon/fortunate/fortunate.php
index b91080f51..5a6302e58 100644
--- a/addon/fortunate/fortunate.php
+++ b/addon/fortunate/fortunate.php
@@ -1,7 +1,10 @@
 <?php
-
-
-
+/**
+ * Name: Fortunate
+ * Description: Add a random fortune cookie at the bottom of every pages.
+ * Version: 1.0
+ * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
+ */
 
 
 function fortunate_install() {
diff --git a/addon/java_upload/java_upload.php b/addon/java_upload/java_upload.php
index 8b8a57604..09e321f0a 100644
--- a/addon/java_upload/java_upload.php
+++ b/addon/java_upload/java_upload.php
@@ -1,6 +1,13 @@
 <?php
 
 /**
+ * Name: Java photo uploader
+ * Description: WARNING: This module currently has privacy issues. The java package does not pass the permissions array intact and could lead to photos being seen by people that were excluded from seeing them.
+ * Version: 1.0
+ * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
+ */
+
+/**
  *
  * Java photo uploader, uses Jumploader
  *
@@ -93,4 +100,4 @@ function java_upload_photo_post_end(&$a,&$b) {
 	if(x($a->data,'java_upload') && $a->data['java_upload'])
 		killme();
 
-}
\ No newline at end of file
+}
diff --git a/addon/js_upload/js_upload.php b/addon/js_upload/js_upload.php
index 9f3fa9600..042e9a988 100644
--- a/addon/js_upload/js_upload.php
+++ b/addon/js_upload/js_upload.php
@@ -1,6 +1,13 @@
 <?php
 
 /**
+ * Name: JS Uploader
+ * Description: JavaScript photo/image uploader. Uses Valum 'qq' Uploader.
+ * Version: 1.0
+ * Author: Chris Case <http://friendika.openmindspace.org/profile/chris_case>
+ */
+
+/**
  *
  * JavaScript Photo/Image Uploader
  *
diff --git a/addon/ldapauth/README b/addon/ldapauth/README
new file mode 100644
index 000000000..cf28ef1e0
--- /dev/null
+++ b/addon/ldapauth/README
@@ -0,0 +1,17 @@
+Authenticate a user against an LDAP directory
+Useful for Windows Active Directory and other LDAP-based organisations
+to maintain a single password across the organisation.
+
+Optionally authenticates only if a member of a given group in the directory.
+
+The person must have registered with Friendika using the normal registration 
+procedures in order to have a Friendika user record, contact, and profile.
+
+Note when using with Windows Active Directory: you may need to set TLS_CACERT in your site
+ldap.conf file to the signing cert for your LDAP server. 
+
+The required configuration options for this module may be set in the .htconfig.php file
+e.g.:
+
+$a->config['ldapauth']['ldap_server'] = 'host.example.com';
+...etc.
diff --git a/addon/ldapauth/ldapauth.php b/addon/ldapauth/ldapauth.php
index 2ec30caad..7230302e9 100644
--- a/addon/ldapauth/ldapauth.php
+++ b/addon/ldapauth/ldapauth.php
@@ -1,5 +1,11 @@
 <?php
-
+/**
+ * Name: LDAP Authenticate
+ * Description: Authenticate a user against an LDAP directory
+ * Version: 1.0
+ * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
+ */
+ 
 /**
  * Friendika addon
  * 
diff --git a/addon/piwik/piwik.php b/addon/piwik/piwik.php
index 52bdaeb0d..032f84f4b 100644
--- a/addon/piwik/piwik.php
+++ b/addon/piwik/piwik.php
@@ -1,4 +1,11 @@
 <?php
+/**
+ * Name: Piwik Analytics
+ * Description: Piwik Analytics Plugin for Friendika
+ * Version: 1.0
+ * Author: Tobias Diekershoff <https://diekershoff.homeunix.net/friendika/profile/tobias>
+ */
+ 
 
 /*   Piwik Analytics Plugin for Friendika
  *
diff --git a/addon/poormancron/poormancron.php b/addon/poormancron/poormancron.php
index 830c10ddf..9a8dc1e33 100644
--- a/addon/poormancron/poormancron.php
+++ b/addon/poormancron/poormancron.php
@@ -1,9 +1,9 @@
 <?php
 /**
- * Poor Man Cron. Execute updates on pageviews
- *
- * Addon Name: poormancron
- *
+ * Name: Poor Man Cron
+ * Description: Execute updates on pageviews, without the need of commandline php
+ * Version: 1.2
+ * Author: Fabio Comuni <http://kirgroup.com/profile/fabrix>
  */
 
 function poormancron_install() {
diff --git a/addon/randplace/randplace.php b/addon/randplace/randplace.php
index fa38de377..bae8e7c69 100644
--- a/addon/randplace/randplace.php
+++ b/addon/randplace/randplace.php
@@ -1,13 +1,12 @@
 <?php
-
-/**
- * Sample Friendika plugin/addon
- *
- * Addon Name: randplace
- *
- */
-
 /**
+ * Name: Random place
+ * Description: Sample Friendika plugin/addon. Set a random place when posting.
+ * Version: 1.0
+ * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
+ * 
+ * 
+ * 
  *
  * Addons are registered with the system in the
  * .htconfig.php file.
@@ -178,4 +177,4 @@ function randplace_settings(&$a,&$s) {
 
 	$s .= '<div class="settings-submit-wrapper" ><input type="submit" name="submit" class="settings-submit" value="' . t('Submit') . '" /></div></div>';
 
-}
\ No newline at end of file
+}
diff --git a/addon/sniper/sniper.php b/addon/sniper/sniper.php
index 79d7daad2..bb4eace30 100644
--- a/addon/sniper/sniper.php
+++ b/addon/sniper/sniper.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Name: Sniper App
+ * Description: Example of flash game application
+ * Version: 1.0
+ * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
+ */
 
 function sniper_install() {
     register_hook('app_menu', 'addon/sniper/sniper.php', 'sniper_app_menu');
@@ -28,4 +34,4 @@ $o .= <<< EOT
 EOT;
 
 return $o;
-}
\ No newline at end of file
+}
diff --git a/addon/statusnet/statusnet.php b/addon/statusnet/statusnet.php
index 39df7d962..e24ebc1ee 100644
--- a/addon/statusnet/statusnet.php
+++ b/addon/statusnet/statusnet.php
@@ -1,5 +1,10 @@
 <?php
-
+/**
+ * Name: StatusNet Connector
+ * Version: 1.0
+ * Author: Tobias Diekershoff <https://diekershoff.homeunix.net/friendika/profile/tobias>
+ */
+ 
 /*   StatusNet Plugin for Friendika
  *
  *   Author: Tobias Diekershoff
diff --git a/addon/tictac/tictac.php b/addon/tictac/tictac.php
index a69cda132..d6cec08a0 100644
--- a/addon/tictac/tictac.php
+++ b/addon/tictac/tictac.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Name: TicTac App
+ * Description: The TicTacToe game application
+ * Version: 1.0
+ * Author: Mike Macgirvin <http://macgirvin.com/profile/mike>
+ */
 
 
 function tictac_install() {
diff --git a/addon/twitter/twitter.php b/addon/twitter/twitter.php
index c59d1b9e5..fef6583f6 100644
--- a/addon/twitter/twitter.php
+++ b/addon/twitter/twitter.php
@@ -1,4 +1,10 @@
 <?php
+/**
+ * Name: Twitter Connector
+ * Version: 1.0
+ * Author: Tobias Diekershoff <https://diekershoff.homeunix.net/friendika/profile/tobias>
+ */
+
 
 /*   Twitter Plugin for Friendika
  *
diff --git a/addon/widgets/widgets.php b/addon/widgets/widgets.php
index af17d9e9a..f5f868222 100644
--- a/addon/widgets/widgets.php
+++ b/addon/widgets/widgets.php
@@ -1,10 +1,11 @@
 <?php
-	/**
-	 * widgets from friendika
-	 * 
-	 * allow to embed info from friendika into another site
-	 */
-	 
+/**
+ * Name: Widgets
+ * Description: Allow to embed info from friendika into another site
+ * Version: 1.0
+ * Author: Fabio Comuni <http://kirgroup.com/profile/fabrix/>
+ */
+ 
 	 
 function widgets_install() {
 	register_hook('plugin_settings', 'addon/widgets/widgets.php', 'widgets_settings');