From ea25e0a6127dcb38f44ba6d57989c8b0466e3f0c Mon Sep 17 00:00:00 2001 From: Tobias Diekershoff Date: Sat, 1 Jun 2013 08:45:37 +0200 Subject: [PATCH] markdownification of the README --- impressum/README | 34 ---------------------------------- impressum/README.md | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+), 34 deletions(-) delete mode 100755 impressum/README create mode 100755 impressum/README.md diff --git a/impressum/README b/impressum/README deleted file mode 100755 index fcf29aaf..00000000 --- a/impressum/README +++ /dev/null @@ -1,34 +0,0 @@ -Impressum Plugin for Friendica - -Author: Tobias Diekershoff - http://diekershoff.homeunix.net/friendika/profile/tobias - tobias.diekershoff@gmx.net - -License: 3-clause BSD license - -About - This plugin adds an Impressum block to the /friendica page with informations - about the page operator/owner and how to contact you in case of any questions. - - In the notes and postal fields you can use HTML tags for formatting. - -Configuration: - Simply fill in the fields in the impressium settings page in the plugins area - of your admin panel. - -If you for any reason prefer to use a configuration file instead, you can set the -following variables in the .htconfig file - - * $a->config['impressum']['owner'] this is the Name of the Operator - * $a->config['impressum']['ownerprofile'] this is an optional Friendica account - where the above owner name will link to - * $a->config['impressum']['email'] a contact email address (optional) - will be displayed slightly obfuscated - as name(at)example(dot)com - - * $a->config['impressum']['postal'] should contain a postal address where - you can be reached at (optional) - * $a->config['impressum']['notes'] additional informations that should - be displayed in the Impressum block - * $a->config['impressum']['footer_text'] Text that will be displayed at - the bottom of the pages. diff --git a/impressum/README.md b/impressum/README.md new file mode 100755 index 00000000..cf420ba1 --- /dev/null +++ b/impressum/README.md @@ -0,0 +1,38 @@ +Impressum Plugin for Friendica +============================== + +* Author: Tobias Diekershoff +* License: [3-clause BSD](http://opensource.org/licenses/BSD-3-Clause) license + (see the LICENSE file in the addon directory) + +About +----- +This plugin adds an Impressum (contact) block to the /friendica page with +informations about the page operator/owner and how to contact you in case of +any questions. + +In the notes and postal fields you can use bbcode tags for formatting, like in +normal friendica postings.. + +Configuration +------------- +Simply fill in the fields in the impressium settings page in the plugins +area of your admin panel. For email adresses the "@" symbol will be obfuscated +in the source of the page to make in harder for harvesting tools. + +Manual Configuration +-------------------- +If you for any reason prefer to use a configuration file instead, you can set the following variables in the .htconfig file + + $a->config['impressum']['owner'] this is the Name of the Operator + $a->config['impressum']['ownerprofile'] this is an optional Friendica account + where the above owner name will link to + $a->config['impressum']['email'] a contact email address (optional) + will be displayed slightly obfuscated + as name(at)example(dot)com + $a->config['impressum']['postal'] should contain a postal address where + you can be reached at (optional) + $a->config['impressum']['notes'] additional informations that should + be displayed in the Impressum block + $a->config['impressum']['footer_text'] Text that will be displayed at + the bottom of the pages.