post-to-liascript-shortcode.../README.md

53 lines
2.2 KiB
Markdown

# Post to LiaScript Shortcode Button
**Plugin Name:** Post to LiaScript Shortcode Button
**Description:** Ermittelt den Content und Titel eines Beitrags, konvertiert den Inhalt in gut strukturiertes Markdown, fügt eine TULLU-Lizenz hinzu, komprimiert und kodiert den Inhalt und gibt einen LiaScript-Link über einen Shortcode aus.
**Version:** 1.0
**Author:** Joachim Happel
## Beschreibung
Sharing und Remixing OER leicht gemacht: Das "Post to LiaScript Shortcode Button" Plugin ermöglicht es, den Inhalt und Titel eines WordPress-Beitrags zu ermitteln, den Inhalt in gut strukturiertes Markdown zu konvertieren, eine Lizenz gemäß der [TULLU-Regel](https://open-educational-resources.de/oer-tullu-regel/) hinzuzufügen und als den Markdown-Inhalt an den [LiaScript Live Editor](https://liascript.github.io/LiveEditor/) zu übergeben. Im Editor kann der Inhalt beliebig angepasst, remixed und anschließend als Lernresource weitergegeben werden.
## Installationshinweise
### Voraussetzungen
- WordPress 5.0 oder höher
- PHP 7.0 oder höher
- Composer (zur Verwaltung von Abhängigkeiten)
### Installation
1. **Laden Sie das Plugin herunter:**
- Klonen Sie dieses Repository oder laden Sie es als ZIP-Datei herunter und entpacken Sie es.
2. **Composer-Abhängigkeiten installieren:**
- Navigieren Sie zum Plugin-Verzeichnis und führen Sie den folgenden Befehl aus:
```sh
composer install
```
3. **Hochladen zum WordPress-Plugin-Verzeichnis:**
- Laden Sie das gesamte Plugin-Verzeichnis, einschließlich des `vendor`-Ordners, der von Composer erstellt wurde, in das `wp-content/plugins`-Verzeichnis auf Ihrem Server.
4. **Plugin aktivieren:**
- Gehen Sie zum WordPress-Dashboard und aktivieren Sie das Plugin.
## Verwendung
Fügen Sie den Shortcode `[shareliascriptbtn class="button" label="Teilen"]` in Ihren Beiträgen oder Seiten ein, um den LiaScript-Link zu generieren. Die Attribute `class` und `label` sind optional und können verwendet werden, um das Aussehen und den Text des Buttons anzupassen.
Beispiel:
```shortcode
[shareliascriptbtn class="custom-button" label="Share"]
```
## Anforderungen
PHP 7.0 oder höher
WordPress 5.0 oder höher
## Lizenz
MIT License