Skip to content

Commit

Permalink
Merge pull request #136 from FriendsOfREDAXO/remove_plugin
Browse files Browse the repository at this point in the history
Plugin "Documentation" aufgelöst
  • Loading branch information
christophboecker authored Feb 25, 2024
2 parents b2b7f91 + 5b96087 commit b524177
Show file tree
Hide file tree
Showing 31 changed files with 236 additions and 800 deletions.
File renamed without changes
2 changes: 1 addition & 1 deletion boot.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
namespace FriendsOfRedaxo\MarkItUp;

use rex;
use rex_addon;
use rex_i18n;
use rex_view;
use rex_addon;

/** @var rex_addon $this */

Expand Down
14 changes: 7 additions & 7 deletions plugins/documentation/docs/de_de/help.md → docs/faq.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Unsere Antworten auf häufige Fragen

### markdown oder textile — das ist hier die Frage.

## markdown oder textile — das ist hier die Frage.

Grundsätzlich ist es sinnvoll in einem System möglichst bei einem Editor für alle Eingabefelder zu bleiben. Das erhöht die Chance, dass der Redakteur den Editor schnell lernt und intuitiv anwenden kann.

Expand All @@ -15,20 +16,20 @@ Einen guten Artikel hat dazu Gerrit van Aaken verfasst (29.10.2009), der dort au

<sup>1</sup> Noch besser: eigenes Modul zum Erstellen von Tabellen bauen. Wir empfehlen dafür die AddOns mForm und mBlock.

### Wie baue ich den Editor in ein Modul ein?
## Wie baue ich den Editor in ein Modul ein?

Beispiele für die Anwendung des AddOns findest Du
... hier in der Doku unter dem Punkt [Editor integrieren](howto_integration.md)
... in der [REX-Modulsammlung via Github](https://github.com/FriendsOfREDAXO/Modulsammlung)


### Wie baue ich den Editor in ein AddOn ein?
## Wie baue ich den Editor in ein AddOn ein?

Für die Entwicklung von AddOns empfiehlt es sich, dem Nutzer verschiedene Editoren (also auch markitUp!) zur Wahl anzubieten.
Die Anleitung dazu ist [in Arbeit](https://github.com/FriendsOfREDAXO/tricks/issues/68).


### Ich brauche Unterstützung, den Editor in Eigenentwicklungen einzubauen. Wer kann mich unterstützen?
## Ich brauche Unterstützung, den Editor in Eigenentwicklungen einzubauen. Wer kann mich unterstützen?

Unterstützung findest Du in der Community
... im [REDAXO-Forum](http://www.redaxo.org/de/forum/) oder
Expand All @@ -37,16 +38,15 @@ Unterstützung findest Du in der Community
> **Hinweis:**
> Solltest Du noch keinen Zugang zu **Slack** haben, kannst Du dich [selbst einladen](http://www.redaxo.org/slack/).
### Ich habe einen Fehler im AddOn gefunden. Was kann ich tun?
## Ich habe einen Fehler im AddOn gefunden. Was kann ich tun?

Am besten meldest Du den Fehler &mdash; sei es im code oder der Dokumentation &mdash; via [GitHub](https://github.com/FriendsOfREDAXO/markitup) per Pull Request oder einfach als Issue.

### Ich habe einen Vorschlag zur Weiterentwicklung des AddOns. Wo bringe ich ihn ein?
## Ich habe einen Vorschlag zur Weiterentwicklung des AddOns. Wo bringe ich ihn ein?

Am besten forkst Du das AddOn via [GitHub](https://github.com/FriendsOfREDAXO/markitup) und gibst Deinen Vorschlag per Pull Request an FOR zurück.
Alternativ kannst Du Deinen Vorschlag auch als Issue (ebenda) einbringen.


## Wo finde ich weitere Hilfe und Unterstützung?

Weitere Anregungen, Fragen und Wünsche kannst Du einbringen
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,10 @@ if(!rex_addon::get('markitup')->isAvailable()) {

```php
<?php
use FriendsOfRedaxo\MarkItUp\MarkItUp;
if ('REX_VALUE[id=1 isset=1]') {
echo MarkItUp::parseOutput ('markdown', 'REX_VALUE[id=1 output="html"]');
}
use FriendsOfRedaxo\MarkItUp\MarkItUp;
if ('REX_VALUE[id=1 isset=1]') {
echo MarkItUp::parseOutput ('markdown', 'REX_VALUE[id=1 output="html"]');
}
?>
```

Expand All @@ -103,10 +103,8 @@ $mform->addTextAreaField(2, ['label'=>'Text', 'class'=>'markitupEditor-markdown_
// Ausrichtung Text
$mform->addSelectField(10,[0 => 'zentriert', 1 => 'links-bündig', 2 => 'rechts-bündig'], ['label'=>'Ausrichtung Text', 'default-value' => '1']);


// get formular
echo $mform->show();

?>
```

Expand All @@ -117,8 +115,8 @@ echo $mform->show();
<?php
use FriendsOfRedaxo\MarkItUp\MarkItUp;

$txtalign = 'REX_VALUE[10]';
$text = 'REX_VALUE[id=2 output=html]';
$txtalign = "REX_VALUE[10]";
$text = "REX_VALUE[id=2 output=html]";

// ########## Ausgabe Backend
if(rex::isBackend()) {
Expand All @@ -131,36 +129,29 @@ if(rex::isBackend()) {


echo 'Ausrichtung des Textes: ';
if ($txtalign == '0') {
echo 'zentriert ';
} elseif ($txtalign == '1') {
echo 'links ';
} elseif ($txtalign == '2') {
echo 'rechts ';
}
if ($txtalign == '0') { echo 'zentriert '; }
elseif ($txtalign == '1') { echo 'links '; }
elseif ($txtalign == '2') { echo 'rechts '; }
}


// ########## Ausgabe Frontend
else {

// row
echo '<div class="row">',PHP_EOL;
echo '<div class="row">'.PHP_EOL;

// column
echo '<div class="column ';
if ($txtalign == '0') {
echo 'txtalign-center ';
} elseif ($txtalign == '1') {
echo 'txtalign-left ';
} elseif ($txtalign == '2') {
echo 'txtalign-right ';
}
if ($txtalign == '0') { echo 'txtalign-center '; }
elseif ($txtalign == '1') { echo 'txtalign-left '; }
elseif ($txtalign == '2') { echo 'txtalign-right '; }
echo 'small-100 medium-100 large-100 xlarge-100">',PHP_EOL;

// Text
echo MarkItUp::parseOutput ('markdown', $text);

echo '</div>',PHP_EOL,'</div>',PHP_EOL,PHP_EOL;
echo '</div>',PHP_EOL,'</div>',PHP_EOL,ÜHP_EOL;
}
?>
```
Expand Down Expand Up @@ -221,12 +212,12 @@ $mform = new MForm();
// Text
$mform->addTextAreaField(2, ['label'=>'Text', 'class'=>'markitupEditor-textile_default']);


// Ausrichtung Text
$mform->addSelectField(10,[0 => 'zentriert', 1 => 'links-bündig', 2 => 'rechts-bündig'], ['label'=>'Ausrichtung Text', 'default-value' => '1']);

// get formular
echo $mform->show();

?>
```

Expand All @@ -237,8 +228,8 @@ echo $mform->show();
<?php
use FriendsOfRedaxo\MarkItUp\MarkItUp;

$txtalign = 'REX_VALUE[10]';
$text = 'REX_VALUE[id=2 output=html]';
$txtalign = "REX_VALUE[10]";
$text = "REX_VALUE[id=2 output=html]";

// ########## Ausgabe Backend
if(rex::isBackend()) {
Expand All @@ -251,37 +242,28 @@ if(rex::isBackend()) {


echo 'Ausrichtung des Textes: ';
if ($txtalign == '0') {
echo 'zentriert ';
} elseif ($txtalign == '1') {
echo 'links ';
} elseif ($txtalign == '2') {
echo 'rechts ';
}
if ($txtalign == '0') { echo 'zentriert '; }
elseif ($txtalign == '1') { echo 'links '; }
elseif ($txtalign == '2') { echo 'rechts '; }
}


// ########## Ausgabe Frontend
else {

// row
echo '<div class="row">',PHP_EOL;
echo '<div class="row">'.PHP_EOL;

// column
echo '<div class="column ';
if ($txtalign == '0') {
echo 'txtalign-center ';
} elseif ($txtalign == '1') {
echo 'txtalign-left ';
} elseif ($txtalign == '2') {
echo 'txtalign-right ';
}
if ($txtalign == '0') { echo 'txtalign-center '; }
elseif ($txtalign == '1') { echo 'txtalign-left '; }
elseif ($txtalign == '2') { echo 'txtalign-right '; }
echo 'small-100 medium-100 large-100 xlarge-100">',PHP_EOL;

// Text
echo MarkItUp::parseOutput ('textile', $text);

echo '</div>',PHP_EOL,'</div>',PHP_EOL,PHP_EOL;
echo '</div>',PHP_EOL,'</div>',PHP_EOL,ÜHP_EOL;
}
?>
```
Expand All @@ -298,7 +280,7 @@ else {
bold,code,clips[Snippetname1=Snippettext1|Snippetname2=Snippettext2],deleted,emaillink, ....
```

![snippets](snippet.jpg)
![snippets](../assets/addons/markitup//docs/snippet.de.jpg)

Klick auf "Snippetname1" würde an der Cursorposition den Text "Snippettext1" einfügen. Komplexe oder größere Textbausteine sprengen schnell den Rahmen des Möglichen,
wenn man sie in der Profil-Konfiguration einbaut. Ergänzend kann in der Tabelle "Snippets" eine Textbausteinbibliothek erfasst werden.
Expand Down Expand Up @@ -403,6 +385,7 @@ Es steht eine Funktion zur Verfügung, mit der Yform-Links in den Textfeldern ü
```php
FriendsOfRedaxo\MarkItUp\MarkItUp::yformLinkInUse( $table_name, $data_id, $tableset=null, $result=false )
```

Die Funktion überprüft für die angegebenen Tabellen (`$tableset`) in den Feldern vom Typ `text`, `mediumtext` und `varchar...`, ob
in ihnen der zu prüfende Link (`$table_name, $data_id`) vorkommt.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,6 @@

Hier findest Du die snippets für die Auszeichnungssprache markdown - jeweils mit Ausgabe (= Vorschau) und dem einzugebendem Code:

- [Überschriften](#ueberschriften)
- [Texte formatieren](#texte)
- [Font-Formate](#formate)
- [Hoch-/Tief-Stellen von Texten](#sub)
- [Links](#links)
- [Anker](#anker)
- [Anker definieren](#anker-definieren)
- [Text auf Anker verlinken](#anker-link)
- [Inhaltsverzeichnis erstellen](#inhalt)
- [Listen](#listen)
- [Tabellen](#tabellen)
- [Code](#code)
- [Zitieren](#zitieren) (in REX auch Hinweise)
- [Bilder](#images)

---

Quellen für diese Anleitung:

[Daring Fireball: Markdown Syntax Documentation](https://daringfireball.net/projects/markdown/syntax)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,6 @@

Hier findest Du die snippets für die Auszeichnungssprache textile - jeweils mit Ausgabe (= Vorschau) und dem einzugebendem Code:

- [Überschriften](#ueberschriften)
- [Texte formatieren](#texte)
- [Font-Formate](#formate)
- [Ausrichten in der Zeile](#ausrichten)
- [Hoch-/Tief-Stellen von Texten](#sub)
- [Listen](#listen)
- [ungeordnete Listen](#ungeordnet)
- [geordnete Listen](#geordnet)
- [Links](#links)
- [Anker](#anker)
- [Anker definieren](#anker-definieren)
- [Text auf Anker verlinken](#anker-link)
- [Inhaltsverzeichnis erstellen](#inhalt)
- [Zitieren](#zitieren) (in REX auch Hinweise)
- [Bilder](#images)
- [Tabellen](#tabellen)
- [Code](#code)

---

Quelle für diese Anleitung und viele weitere Tipps & Tricks:
[www.rexdev.de/cheatsheets/textile](http://rexdev.de/cheatsheets/textile.html)
[www.txstyle.org](http://txstyle.org)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ via [http://markitup.jaysalvat.com](http://markitup.jaysalvat.com)
### Adaption für REDAXO und AddOn-Entwicklung

Vielen Dank an das FOR-Team @FriendsOfREDAXO, insbesondere an
Thomas Kaegi (@phoebusryan)
Dirk Schürjohann (@schuer)
Gregor Harlan (@gharlan)
Franziska Köppe (@madiko)
- Thomas Kaegi (@phoebusryan)
- Dirk Schürjohann (@schuer)
- Gregor Harlan (@gharlan)
- Franziska Köppe (@madiko)

---

Expand Down
Loading

0 comments on commit b524177

Please sign in to comment.