Skip to content

Commit cee897a

Browse files
authored
Merge pull request #146 from dragomano/docs
Update docs
2 parents 34f62cd + 3fb2870 commit cee897a

File tree

16 files changed

+404
-65
lines changed

16 files changed

+404
-65
lines changed

.github/workflows/deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
- name: Setup Node
2727
uses: actions/setup-node@v3
2828
with:
29-
node-version: '16'
29+
node-version: '20'
3030

3131
- name: Get yarn cache
3232
id: yarn-cache

website/i18n/de/docusaurus-plugin-content-docs/current/getting-started/configuration.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ In diesem Abschnitt können Sie die allgemeinen Einstellungen von Seiten und Bl
5353
* Links zu den vorherigen und nächsten Seiten anzeigen – aktivieren Sie dies, falls Sie Links auf Seiten sehen möchten, die vor und nach der aktuellen Seite erzeugt wurden.
5454
* Verwandte Seiten anzeigen – falls es Seiten gibt, die einer Seite ähnlich sind (bezüglich Titel und Alias), werden Sie unten auf der Seite angezeigt.
5555
* Seitenkommentare zeigen – für Benutzergruppen mit der Berechtigung, Seiten zu kommentieren, wird am Seitenende ein Kommentarformular angezeigt.
56-
* In Kommentaren erlaubter BBCode – Sie können Tags angeben, die beim Kommentieren von Seiten verwendet werden dürfen.
5756
* Maximale Zeit nach dem Kommentieren, in der Änderungen vorgenommen werden können - nach der angegebenen Zeit (nach dem Erzeugen eines Kommentars) werden Sie Ihre Kommentare nicht mehr anpassen können.
5857
* Anzahl der direkten Kommentare pro Seite – geben Sie die maximale Anzahl von Kommentaren an, die keine Antworten auf andere Kommentare sind, die auf einer einzelnen Seite angezeigt werden sollen.
5958
* Sortiere Kommentare standardmäßig — wählen Sie das gewünschte Sortierverfahren für Kommentare auf Portalseiten aus.

website/i18n/de/docusaurus-plugin-content-docs/current/getting-started/updating.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ sidebar_position: 2
33
---
44

55
# Version aktualisieren
6+
67
Falls im Änderungsprotokoll der neuesten Version keine weiteren Hinweise enthalten sind, reicht es aus, die Verzeichnisse `Themes` und `Sources` aus dem Modifikations-Archiv in das Wurzelverzeichnis Ihres Forums zu entpacken, dabei existierende Dateien zu überschreiben, und das Update ist erledigt. Allerdings ist es am besten, die aktuelle Version zu deinstallieren bevor Sie die neue Version installieren.
78

89
:::info
@@ -12,8 +13,3 @@ Seit Version 2.2.1 können Sie upgraden ohne die vorherige Version zu deinstalli
1213
![Aktualisieren](upgrade.png)
1314

1415
:::
15-
16-
## Problembehebung
17-
18-
### Warning: Undefined array key "bla-bla-bla"
19-
Falls Sie nach dem Update einen vergleichbaren Fehler im Portalblock sehen, versuchen Sie die Einstellungen des Blocks aufzurufen und Sie erneut zu speichern. Dies ist kein Fehler, sondern eine Warnung über fehlende (neue) Blockeinstellungen in der Datenbank.

website/i18n/de/docusaurus-plugin-content-docs/current/intro.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@ slug: /
55

66
# Einführung
77

8-
Willkommen zum Light-Portal-Schnellstart!
8+
Welcome to the Light Portal Quick Start!
99

1010
> Light Portal ist eine Modifikation, die Ihr [SMF](https://www.simplemachines.org)-basiertes Forum in ein einfaches und praktisches Portal mit Blöcken und Seiten verwandelt.
11+
12+
---
13+
14+
I want to make sure you’re getting the most out of LP and that no questions go unanswered.
15+
16+
If you have any questions or general thoughts, leave them in [the support topic](https://www.simplemachines.org/community/index.php?topic=572393.0) or [GitHub Discussions](https://github.com/dragomano/Light-Portal/discussions) and I’ll get back to you ASAP.

website/i18n/de/docusaurus-plugin-content-docs/current/plugins/all-hooks.md

Lines changed: 73 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,167 +3,239 @@ sidebar_position: 4
33
---
44

55
# Portal-Hooks
6+
67
Dank Plugins ist Light Portal wundervoll erweiterbar. Hooks helfen Plugins, mit verschiedenen Komponenten des Portals zu interagieren.
78

89
## Grundlegende Hooks
910

1011
### init
12+
1113
> $txt-Variablen überschreiben, SMF-Hooks ausführen, etc.
1214
1315
### prepareEditor
16+
1417
(`$context['lp_block']` for block, `$context['lp_page']` for page)
18+
1519
> Beliebigen Code zum Block-/Seite-Bearbeiten-Bereich hinzufügen
1620
1721
### parseContent
22+
1823
(`&$content, $type`)
24+
1925
> Den Inhalt von benutzerdefinierten Block-/Seitentypen parsen
2026
2127
### prepareContent
28+
2229
(`$data, $parameters`)
30+
2331
> Den benutzerdefinierten Inhalt Ihres Plugins hinzufügen
2432
2533
### credits
34+
2635
(`&$links`)
36+
2737
> Lizenzen der verwendeten Bibliotheken/Scripts etc. hinzufügen
2838
2939
### addAdminAreas
40+
3041
(`&$admin_areas`)
42+
3143
> Benutzerdefinierte Bereiche zu SMFs „integrate_admin_areas“-Hook hinzufügen
3244
3345
## Mit Blöcken arbeiten
3446

3547
### blockOptions
48+
3649
(`&$options`)
50+
3751
> Benutzerdefinierte Blockparameter hinzufügen
3852
3953
### prepareBlockFields
54+
4055
> Benutzerdefinierte Felder zum Block-Erstellungsbereich hinzufügen
4156
4257
### validateBlockData
58+
4359
(`&$parameters, $context['current_block']['type']`)
60+
4461
> Benutzerdefinierte Verifizierungsregeln für das Hinzufügen/Bearbeiten von Blöcken hinzufügen
4562
4663
### findBlockErrors
64+
4765
(`&$post_errors, $data`)
66+
4867
> Benutzerdefinierte Fehlerbehandlung für das Hinzufügen/Bearbeiten von Blöcken hinzufügen
4968
5069
### onBlockSaving
70+
5171
(`$item`)
72+
5273
> Benutzerdefinierte Aktionen beim Speichern/Bearbeiten von Blöcken
5374
5475
### onBlockRemoving
76+
5577
(`$items`)
78+
5679
> Benutzerdefinierte Aktionen beim Löschen von Blöcken
5780
5881
## Mit Seiten arbeiten
5982

6083
### pageOptions
84+
6185
(`&$options`)
86+
6287
> Benutzerdefinierte Seitenparameter hinzufügen
6388
6489
### preparePageFields
90+
6591
> Benutzerdefinierte Felder zum Seiten-Erstellungsbereich hinzufügen
6692
6793
### validatePageData
94+
6895
(`&$parameters`)
96+
6997
> Benutzerdefinierte Verifizierungsregeln für das Hinzufügen/Bearbeiten von Seiten hinzufügen
7098
7199
### findPageErrors
100+
72101
(`&$post_errors, $data`)
102+
73103
> Benutzerdefinierte Fehlerbehandlung für das Hinzufügen/Bearbeiten von Seiten hinzufügen
74104
75105
### onPageSaving
106+
76107
(`$item`)
108+
77109
> Benutzerdefinierte Aktionen beim Speichern/Bearbeiten von Seiten
78110
79111
### onPageRemoving
112+
80113
(`$items`)
114+
81115
> Benutzerdefinierte Aktionen beim Löschen von Seiten
82116
83117
### preparePageData
118+
84119
(`&$data`, `$is_author`)
120+
85121
> Benutzerdefinierte Vorbereitung der Daten der aktuellen Seite des Portals
86122
87123
### beforePageContent
124+
88125
> Bietet die Möglichkeit, etwas vor dem Inhalt der Portalseite anzuzeigen
89126
90127
### afterPageContent
128+
91129
> Bietet die Möglichkeit, etwas nach dem Inhalt der Portalseite anzuzeigen
92130
93131
### comments
132+
94133
> Benutzerdefiniertes Kommentar-Script zur aktuellen Portalseitenansicht hinzufügen
95134
96135
### commentButtons
97-
(`$comment`)
136+
137+
(`$comment`, `&$buttons`)
138+
98139
> Benutzerdefinierte Schaltflächen unter jedem Kommentar hinzufügen
99140
100141
## Mit Plugins arbeiten
101142

102143
### addSettings
144+
103145
(`&$config_vars`)
146+
104147
> Benutzerdefinierte Einstellungen zu Ihrem Plugin hinzufügen
105148
106149
### saveSettings
150+
107151
(`&$plugin_options`)
152+
108153
> Zusätzliche Aktionen nach dem Speichern von Plugin-Einstellungen
109154
110155
## Portaleinstellungen
111156

112157
### addBlockAreas
158+
113159
(`&$subActions`)
160+
114161
> Benutzerdefinierte Reiter in den Block-Einstellungen hinzufügen
115162
116163
### addPageAreas
164+
117165
(`&$subActions`)
166+
118167
> Benutzerdefinierte Reiter in den Seiten-Einstellungen hinzufügen
119168
120169
## Mit Artikeln arbeiten
121170

122171
### frontModes
172+
123173
(`&$this->modes`)
174+
124175
> Benutzerdefinierte Modi für die Hauptseite hinzufügen
125176
126177
### frontCustomTemplate
178+
127179
(`$layouts`)
180+
128181
> Benutzerdefinierte Vorlagen für die Hauptseite hinzufügen
129182
130183
### frontAssets
184+
131185
> Benutzerdefinierte Scripts und Stile zur Hauptseite hinzufügen
132186
133187
### frontTopics
188+
134189
(`&$this->columns, &$this->tables, &$this->wheres, &$this->params, &$this->orders`)
190+
135191
> Benutzerdefinierte Spalten, Tabellen, WHEREs, Parameter und Sortierung zur _init_-Funktion hinzufügen
136192
137193
### frontTopicsOutput
194+
138195
(`&$topics, $row`)
196+
139197
> Verschiedene Manipulationen der Query-Ergebnisse der _getData_-Funktion
140198
141199
### frontPages
200+
142201
(`&$this->columns, &$this->tables, &$this->wheres, &$this->params, &$this->orders`)
202+
143203
> Benutzerdefinierte Spalten, Tabellen, WHEREs, Parameter und Sortierung zur _init_-Funktion hinzufügen
144204
145205
### frontPagesOutput
206+
146207
(`&$pages, $row`)
208+
147209
> Verschiedene Manipulationen der Query-Ergebnisse der _getData_-Funktion
148210
149211
### frontBoards
212+
150213
(`&$this->columns, &$this->tables, &$this->wheres, &$this->params, &$this->orders`)
214+
151215
> Benutzerdefinierte Spalten, Tabellen, WHEREs, Parameter und Sortierung zur _init_-Funktion hinzufügen
152216
153217
### frontBoardsOutput
218+
154219
(`&$boards, $row`)
220+
155221
> Verschiedene Manipulationen der Query-Ergebnisse der _getData_-Funktion
156222
157223
## Mit Symbolen arbeiten
158224

159225
### prepareIconList
226+
160227
(`&$all_icons, &$template`)
228+
161229
> Benutzerdefinierte Symbole (statt FontAwesome) hinzufügen
162230
163231
### prepareIconTemplate
232+
164233
(`&$template, $icon`)
234+
165235
> Benutzerdefinierte Vorlage zum Anzeigen von Symbolen hinzufügen
166236
167237
### changeIconSet
238+
168239
(`&$set`)
240+
169241
> Bietet die Möglichkeit, Interface-Symbole, die über das `$this->context['lp_icon_set']`-Array verfügbar sind, zu erweitern

website/i18n/de/docusaurus-plugin-content-docs/current/plugins/create-new.md

Lines changed: 54 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ sidebar_position: 2
33
---
44

55
# Plugin hinzufügen
6+
67
Plugins sind die Erweiterungen, die die Fähigkeiten von Light Portal erweitern. Um Ihr eigenes Plugin zu erzeugen, folgen Sie einfach den Anweisungen unterhalb.
78

89
:::info
@@ -12,22 +13,59 @@ Sie können **PluginMaker** bei der Erstellung Ihrer eigenen Plugins zu Hilfe ne
1213
:::
1314

1415
## Wählen Sie die Art von Plugin
16+
1517
Aktuell sind die folgenden Arten von Plugins verfügbar:
1618

17-
* `block` — Plugins, die einen neuen Blocktyp für das Portal hinzufügen
18-
* `ssi` — Plugins (normalerweise Blöcke), die SSI-Funktionen verwenden, um Daten abzurufen
19-
* `editor` — Plugins, die einen Drittanbieter-Editor für verschiedene Arten von Inhalten hinzufügen
20-
* `comment` — Plugins, die ein Drittanbieter-Kommentar-Widget hinzufügen
21-
* `parser` — Plugins, die einen Parser für den Inhalt von Seiten und Blöcken implementieren
22-
* `article` — Plugins, um den Inhalt von Artikelkarten auf der Hauptseite zu verarbeiten
23-
* `frontpage` — Plugins, die die Hauptseite des Portals ändern
24-
* `impex` — Plugins zum Importieren und Exportieren diverser Portalelemente
25-
* `block_options` und `page_options` — Plugins, die weitere Parameter für das entsprechende Element (Block oder Seite) hinzufügen
26-
* `icons` — Plugins, die neue Symbolbibliotheken hinzufügen, um Interface-Elemente zu ersetzen oder sie in Blocküberschriften zu verwenden
27-
* `seo` — Plugins, die in irgendeiner Weise die Sichtbarkeit des Forums im Netzwerk beeinflussen
28-
* `other` — Plugins, die in keine der obigen Kategorien fallen
19+
### `Block`
20+
21+
Plugins that add a new type of blocks for the portal.
22+
23+
### `ssi`
24+
25+
Plugins (usually blocks) that use SSI functions to retrieve data.
26+
27+
### `editor`
28+
29+
Plugins that add a third-party editor for different types of content.
30+
31+
### `comment`
32+
33+
Plugins that add a third-party comment widget instead of the built-in.
34+
35+
### `parser`
36+
37+
Plugins that implement the parser for the content of pages and blocks.
38+
39+
### `article`
40+
41+
Plugins for processing the content of article cards on the main page.
42+
43+
### `frontpage`
44+
45+
Plugins for changing the main page of the portal.
46+
47+
### `impex`
48+
49+
Plugins for importing and exporting various portal elements.
50+
51+
### `block_options` | `page_options`
52+
53+
Plugins that add additional parameters for the corresponding entity (block or .page).
54+
55+
### `icons`
56+
57+
Plugins that add new icon libraries to replace interface elements or for use in block headers
58+
59+
### `seo`
60+
61+
Plugins that somehow affect the visibility of the forum on the network.
62+
63+
### `other`
64+
65+
Plugins that are not related to any of the categories above.
2966

3067
## Ein Plugin-Verzeichnis erzeugen
68+
3169
Erzeugen Sie ein separates Verzeichnis für Ihre Plugin-Dateien, innerhalb von `/Sources/LightPortal/Addons`. Falls Ihr Plugin zum Beispiel `HelloWorld` heißt, sollte die Verzeichnisstruktur wie folgt aussehen:
3270

3371
```
@@ -75,14 +113,16 @@ class HelloWorld extends Plugin
75113
```
76114

77115
## Verwendung von SSI
116+
78117
Falls das Plugin Daten über SSI-Funktionen abrufen muss, verwenden Sie die eingebaute `getFromSsi(string $function, ...$params)`-Methode. Als Parameter `$function` müssen Sie den Namen einer der Funktionen übergeben, die in der Datei **SSI.php** enthalten sind, ohne Präfix `ssi_`. Zum Beispiel:
79118

80119
```php
81120
<?php
82121

83-
// See ssi_topTopics function in the SSI.php file
84-
$data = $this->getFromSsi('topTopics', 'views', 10, 'array');
122+
// See ssi_topTopics function in the SSI.php file
123+
$data = $this->getFromSsi('topTopics', 'views', 10, 'array');
85124
```
86125

87126
## Verwendung von Composer
127+
88128
Ihr Plugin kann Drittanbieter-Bibliotheken verwenden, die mit Composer installiert wurden. Stellen Sie sicher, dass die Datei `composer.json`, die die notwendigen Abhängigkeiten enthält, im Plugins-Verzeichnis liegt. Bevor Sie Ihr Plugin veröffentlichen, öffnen Sie das Plugin-Verzeichnis auf der Kommandozeile und führen diesen Befehl aus: `composer install --no-dev -o`. Anschließend kann der gesamte Inhalt des Plugin-Verzeichnisses als separate SMF-Modifikation verpackt werden (sehen Sie sich zum Beispiel das **PluginMaker**-Paket an).

website/i18n/el/docusaurus-plugin-content-docs/current/getting-started/configuration.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,6 @@ sidebar_position: 3
5353
* Εμφάνιση συνδέσμων προς τις προηγούμενες και τις επόμενες σελίδες — ενεργοποιήστε το εάν θέλετε να δείτε συνδέσμους σε σελίδες που δημιουργήθηκαν πριν και μετά την τρέχουσα σελίδα.
5454
* Εμφάνιση σχετικών σελίδων — εάν μια σελίδα έχει παρόμοιες σελίδες (κατά τίτλο και ψευδώνυμο), αυτές θα εμφανίζονται στο κάτω μέρος της σελίδας.
5555
* Εμφάνιση σχολίων σελίδας — εάν επιτρέπεται να σχολιάσετε μια σελίδα, μια φόρμα σχολίων θα εμφανιστεί στο κάτω μέρος της σελίδας.
56-
* Επιτρέπεται το BBCode στα σχόλια — μπορείτε να καθορίσετε ετικέτες που επιτρέπεται να χρησιμοποιούνται όταν σχολιάζετε σελίδες.
5756
* Μέγιστος χρόνος μετά το σχόλιο για να επιτρέπεται η επεξεργασία — μετά την καθορισμένη ώρα (μετά τη δημιουργία σχολίου), δεν θα μπορείτε να αλλάξετε σχόλια.
5857
* Αριθμός γονικών σχολίων ανά σελίδα — καθορίστε τον μέγιστο αριθμό σχολίων που δεν είναι υποσχόλια να θα εμφανίζονται σε μία σελίδα.
5958
* Ταξινόμηση σχολίων από προεπιλογή — επιλέξτε τον επιθυμητό τύπο ταξινόμησης για σχόλια σε σελίδες πύλης.

0 commit comments

Comments
 (0)