FriendsOfREDAXO · schorschy · Aug 10, 2020 · Aug 9, 2020 · Aug 9, 2020 · Aug 9, 2020
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Friends Of REDAXO
+Copyright (c) 2020 Friends Of REDAXO
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.de.md b/README.de.md
@@ -0,0 +1,76 @@
+# MarkItUp Editor
+
+Integriert den [MarkItUp-Editor](http://markitup.jaysalvat.com/) (Markdown und Textile) in REDAXO CMS.
+
+![Screenshot](https://raw.githubusercontent.com/FriendsOfREDAXO/markitup/assets/rex_markitup.png)
+
+Textareas mit der Klasse `markitupEditor-%profileName%` werden automatisch von einem normalen Texteingabefeld in einen MarkItUp-Editor umgewandelt, zum Beispiel:
+
+```html
+<textarea id="markitup_full" class="markitupEditor-full"></textarea>
+```
+
+Im Backend können verschiedene Profile mit unterschiedlichen Konfigurationseinstellungen für den MarkItUp-Editor angelegt werden.
+
+Es gibt die Möglichkeit, dem Editor eigene CSS-Styles zu geben. Dafür muss lediglich im Ordner `/assets/addons/markitup` eine Datei mit dem Namen `skin.css` angelegt werden.
+
+
+## Markdown
+
+Modul-Eingabe:
+
+```html
+<fieldset class="form-horizontal">
+  <div class="form-group">
+    <label class="col-sm-2 control-label" for="value-1">VALUE 1</label>
+    <div class="col-sm-10">
+      <textarea class="form-control markitupEditor-markdown_full" id="value-1" name="REX_INPUT_VALUE[1]">REX_VALUE[1]</textarea>
+    </div>
+  </div>
+</fieldset>
+```
+
+Modul-Ausgabe:
+
+```php
+<?php
+  echo markitup::parseOutput ('markdown', 'REX_VALUE[id=1 output="html"]');
+?>
+```
+
+## Textile
+
+Modul-Eingabe:
+
+```html
+<fieldset class="form-horizontal">
+  <div class="form-group">
+    <label class="col-sm-2 control-label" for="value-1">VALUE 1</label>
+    <div class="col-sm-10">
+      <textarea class="form-control markitupEditor-textile_full" id="value-1" name="REX_INPUT_VALUE[1]">REX_VALUE[1]</textarea>
+    </div>
+  </div>
+</fieldset>
+```
+
+Modul-Ausgabe:
+
+```php
+<?php
+  echo markitup::parseOutput ('textile', 'REX_VALUE[id=1 output="html"]');
+?>
+```
+
+## Profil anlegen
+
+Beispielcode zur Nutzung in Templates, Modulen oder AddOns:
+
+```php
+<?php
+  if (!markitup::profileExists('simple')) {
+
+    // name, description, type (markdown/textile), min height, max height, url type (relative/absolute), buttons
+    markitup::insertProfile ('simple', 'Simple editor', 'textile', 300, 800, 'relative', 'bold,italic');
+  }
+?>
+```
diff --git a/README.md b/README.md
@@ -1,6 +1,76 @@
-MarkItUp Editor
-================================
+# MarkItUp Editor
 
-Addon für REDAXO 5: Bindet den [MarkItUp-Editor](http://markitup.jaysalvat.com/) im Backend ein.
+Integrates the [MarkItUp Editor](http://markitup.jaysalvat.com/) (Markdown and Textile) into REDAXO CMS.
 
 ![Screenshot](https://raw.githubusercontent.com/FriendsOfREDAXO/markitup/assets/rex_markitup.png)
+
+Textarea fields with the class `markitupEditor-%profileName%` will automatically be turned into a proper MarkItUp editor field, for example:
+
+```html
+<textarea id="markitup_full" class="markitupEditor-full"></textarea>
+```
+
+You can setup multiple profiles with different configurations to use with the MarkItUp editor in the backend.
+
+You can even define your own skin for the editor using CSS. To do so, add a file called `skin.css` in the folder `/assets/addons/markitup`.
+
+
+## Markdown
+
+Module input:
+
+```html
+<fieldset class="form-horizontal">
+  <div class="form-group">
+    <label class="col-sm-2 control-label" for="value-1">VALUE 1</label>
+    <div class="col-sm-10">
+      <textarea class="form-control markitupEditor-markdown_full" id="value-1" name="REX_INPUT_VALUE[1]">REX_VALUE[1]</textarea>
+    </div>
+  </div>
+</fieldset>
+```
+
+Module output:
+
+```php
+<?php
+  echo markitup::parseOutput ('markdown', 'REX_VALUE[id=1 output="html"]');
+?>
+```
+
+## Textile
+
+Module input:
+
+```html
+<fieldset class="form-horizontal">
+  <div class="form-group">
+    <label class="col-sm-2 control-label" for="value-1">VALUE 1</label>
+    <div class="col-sm-10">
+      <textarea class="form-control markitupEditor-textile_full" id="value-1" name="REX_INPUT_VALUE[1]">REX_VALUE[1]</textarea>
+    </div>
+  </div>
+</fieldset>
+```
+
+Module output:
+
+```php
+<?php
+  echo markitup::parseOutput ('textile', 'REX_VALUE[id=1 output="html"]');
+?>
+```
+
+## Create new profile
+
+Example code for use in templates, modules or AddOns:
+
+```php
+<?php
+  if (!markitup::profileExists('simple')) {
+
+    // name, description, type (markdown/textile), min height, max height, url type (relative/absolute), buttons
+    markitup::insertProfile ('simple', 'Simple editor', 'textile', 300, 800, 'relative', 'bold,italic');
+  }
+?>
+```
diff --git a/help.php b/help.php
diff --git a/install.php b/install.php
@@ -35,7 +35,7 @@
 $sql->setTable( $tableName );
 $sql->setValue( 'id', 1 );
 $sql->setValue( 'name', 'textile_full' );
-$sql->setValue( 'description', 'Standard MarkItUp-Konfiguration' );
+$sql->setValue( 'description', 'Textile default configuration' );
 $sql->setValue( 'urltype', 'relative' );
 $sql->setValue( 'minheight', '300' );
 $sql->setValue( 'maxheight', '800' );
@@ -49,7 +49,7 @@
 $sql->setTable( $tableName );
 $sql->setValue( 'id', 2 );
 $sql->setValue( 'name', 'markdown_full' );
-$sql->setValue( 'description', 'Standard MarkItUp-Konfiguration' );
+$sql->setValue( 'description', 'Markdown default configuration' );
 $sql->setValue( 'urltype', 'relative' );
 $sql->setValue( 'minheight', '300' );
 $sql->setValue( 'maxheight', '800' );

diff --git a/lang/de_de.lang b/lang/de_de.lang
@@ -1,8 +1,5 @@
 markitup_title = MarkItUp Editor
 
-#subpage help
-markitup_help_infotext = Das Addon bindet den MarkItUp-Editor im Backend ein.<br><br>Textareas mit der Klasse <i>markitupEditor-%profileName%</i> werden automatisch von einem normalen Texteingabefeld in einen MarkItUp-Editor umgewandelt.<br>z.B.: <textarea id="markitup_full" <b>class="markitupEditor-full"</b>></textarea><br><br>Im Backend können verschiedene Profile mit unterschiedlichen Konfigurationseinstellungen für den MarkItUp-Editor angelegt werden.<br><br>Es gibt die Möglichkeit, dem Editor eigene CSS-Styles zu geben. Dafür muss lediglich im Ordner /assets/addons/markitup eine Datei mit dem Namen skin.css angelegt werden.
-
 #cache message
 markitup_cache = {1} konnte nicht geändert werden.
 
@@ -116,3 +113,6 @@ markitup_validate_invalid = Der Wert für "{0}" ist nicht zulässig.
 #permissions
 perm_general_markitup[] = Rechte für MarkItUp-Addon
 perm_general_markitup[profiles] = Rechte für die Seite 'Profile' des MarkItUp-Addons
+
+#subpage description
+markitup_description = Erklärung
diff --git a/lang/en_gb.lang b/lang/en_gb.lang
@@ -1,8 +1,5 @@
 markitup_title = MarkItUp Editor
 
-#subpage help
-markitup_help_infotext = This addon allows usage of the MarkItUp editor in the backend.<br><br>Textarea fields with the class <i>markitupEditor-%profileName%</i> will automatically be turned into a proper MarkItUp editor field.<br>Example: <textarea id="markitup_full" <b>class="markitupEditor-full"</b>></textarea><br><br>You can setup multiple profiles with different configurations to use with the MarkItUp editor in the backend. <br><br>You can even define your own skin for the editor using CSS. To do so, add a file called skin.css in the folder /assets/addons/markitup
-
 #cache message
 markitup_cache = {1} not updated
 
@@ -116,3 +113,6 @@ markitup_validate_invalid = Invalid value for "{0}".
 #permissions
 perm_general_markitup[] = Permissions for the MarkItUp-Addon
 perm_general_markitup[profiles] = Permissions for the page 'Profiles' of the MarkItUp-Addon
+
+#subpage description
+markitup_description = Description
diff --git a/lang/es_es.lang b/lang/es_es.lang
@@ -1,8 +1,5 @@
 markitup_title = MarkItUp Editor
 
-#subpage help
-markitup_help_infotext = El complemento incluye el editor MarkItUp en el backend <br><br>Textareas con la clase <i> markitupEditor-%profileName%</i> se convierten automáticamente de un campo de entrada de texto normal a un editor MarkItUp.<br>ej.: <textarea id="markitup_full" <b>class="markitupEditor-full"</b></textarea><br><br>Se pueden crear varios perfiles con diferentes configuraciones para el Editor de MarkItUp en el backend.<br><br>Existe la posibilidad de darle al editor estilos de CSS propios. Todo lo que tienes que hacer es crear un archivo llamado skin.css en la carpeta /assets/addons/markitup .
-
 #cache message
 markitup_cache = {1} no actualizado
 
@@ -116,3 +113,6 @@ markitup_validate_invalid = Valor no válido para "{0}".
 #permissions
 perm_general_markitup[] = Derechos para el complemento MarkItUp
 perm_general_markitup[profiles] = Derechos para la página 'Perfil' del complemento MarkItUp
+
+#subpage description
+markitup_description = Descripción
diff --git a/lang/pt_br.lang b/lang/pt_br.lang
@@ -1,8 +1,5 @@
 markitup_title = MarkItUp Editor
 
-#subpage help
-markitup_help_infotext = Este addon permite o uso do editor MarkItUp no backend.<br><br> campos textuais com a classe <i>markitupEditor-%profileName%</i>Será automaticamente transformado em um campo apropriado Editor MarkItUp. <br> Exemplo: <textarea id="markitup_full" <b>class="markitupEditor-full"</b>></textarea><br><br> Você pode configurar vários perfis com configurações diferentes para usar com o editor MarkItUp no backend.<br> <br> Você pode até mesmo definir sua própria pele para o editor usando CSS. Para fazer isso, adicione um arquivo chamado skin.css na pasta / ativos / addons / markitup
-
 #cache message
 markitup_cache = {1}não atualizado
 
@@ -93,3 +90,6 @@ markitup_profiles_buttons_unorderedlist_description = Insere uma lista não orde
 #permissions
 perm_general_markitup[] = Permissões para o MarkItUp-Addon
 perm_general_markitup[profiles] = Permissões da página "Perfis" do MarkItUp-Addon
+
+#subpage description
+markitup_description = Descrição
diff --git a/lang/sv_se.lang b/lang/sv_se.lang
@@ -1,8 +1,5 @@
 markitup_title = MarkItUp Editor
 
-#subpage help
-markitup_help_infotext = Denna tillägg tillåter användning av MarkItUp-redigeraren i backend. <br> <br> Textarea-fält med klassen <i> markitupEditor-% profileName% </i> kommer automatiskt att omvandlas till ett korrekt MarkItUp-redigeringsfält. <br> Exempel : <Textarea id = "markitup_full" <b> class = "markitupEditor-full" </b> > </textarea><br><br>Du kan konfigurera flera profiler med olika konfigurationer att använda med MarkItUp-redigeraren i backend.<br> <br>Du kan även definiera egna stilar för redaktören med hjälp av CSS. För att göra så lägg till en fil som heter skin.css i mappen / tillgångar / addons / markitup
-
 #cache message
 markitup_cache = {1} inte uppdaterat
 
@@ -116,3 +113,6 @@ markitup_validate_invalid = Värdet för "{0}" är inte tillåtet.
 #permissions
 perm_general_markitup[] = Rättigheter för MarkItUp-Addon
 perm_general_markitup[profiles] = Rättigheter för sidan 'Profiles' av MarkItUp-Addon
+
+#subpage description
+markitup_description = Förklaring
diff --git a/package.yml b/package.yml
@@ -10,10 +10,11 @@ page:
     subpages:
         profiles: { title: 'translate:profiles', perm: markitup[profiles] }
         snippets: { title: 'translate:snippets', perm: markitup[snippets] }
+        overview: { title: 'translate:description', subPath: README.md }
 
 conflicts:
     packages:
         textile: '*'
 
 requires:
-    redaxo: '^5.1.0'
+    redaxo: '^5.2.0'