-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathpackage.yml
111 lines (100 loc) · 4.81 KB
/
package.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
# Definiert das AddOn, grundlegende Einstellungen - Diese Detei ist unbedingt erforderlich
# Dokumentation der `package.yml` https://redaxo.org/doku/master/addon-package
# Alle hier gesetzten Werte können über `$addon->getProperty($key)` abgefragt werden
package: demo_addon # Pflichtfeld
version: "1.2.1" # Pflichtfeld
author: Friends Of REDAXO # Pflichtfeld für FOR-AddOns
supportpage: https://github.com/FriendsOfREDAXO/demo_addon # Github-Adresse des AddOns
# Werte die mit `translate:` beginnen, werden anhand der Sprachdatei (lang/sprache.lang) übersetzt.
# Der AddOn-Präfix (hier `demo_addon_`) kann weggelassen werden.
# Seiten des AddOns
page:
title: "translate:navititle" # Bezeichnung in der REDAXO Navigation
icon: rex-icon fa-desktop # Icon von Font Awesome
perm: admin # Seite ist nur für Admins erreichbar
pjax: true # Hier kann die Verwendung von PJAX für das eigene AddOn gesteuert werden
# mit der Einstellung `prio` kann die Position im Hauptmenü beeinflusst werden
#prio: 10
# Eigener Block in der REDAXO-Navigation
# Bezeichnung in der .lang-Datei mit `navigation_+addon-Id` also hier `navigation_demo_addon`
block: demo_addon
# Unterseiten
subpages:
intro:
title: "translate:intro"
icon: rex-icon fa-desktop # Icon von Font Awesome
perm: demo_addon[] # Das AddOn stellt ein Benutzerrecht bereit, das aktiviert sein muss, um diese Unterseite zu erreichen. Admins haben alle Rechte.
subpages: # Weitere Subpages der Hauptseite
readme: { title: "translate:readme", subPath: "README.md" } # README.md aus AddOn-Pfad einbinden
description:
{ title: "translate:description", subPath: "pages/DESCRIPTION.md" }
properties: { title: "translate:properties" }
changelog: { title: "translate:changelog", subPath: "CHANGELOG.md" } # Abweichender Titel zur .md-Datei
hidden: {
title: "translate:hidden_subpage",
subPath: "pages/DESCRIPTION.md",
hidden: true,
} # Versteckte Subpage, nur als Beispiel
config:
title: "translate:config"
perm: demo_addon[config] # Das noch spezifischere AddOn-Benutzerrecht `config` ist für diese Unterseite erforderlich. Admins haben alle Rechte.
icon: rex-icon fa-wrench # Icon von Font Awesome
subpages: # Weitere Subpages der Seite config
rex_config_form:
title: "translate:config_rex_config_form"
classic_form:
title: "translate:config_classic_form"
tables:
title: "translate:tables"
icon: rex-icon fa-table
subpages: # Weitere Subpages der Seite tables
tables: { title: "translate:tables", subPath: "pages/TABLES.md" }
updatetable: { title: "translate:updatetable" }
eps:
title: "translate:eps"
icon: rex-icon fa-rocket
subpages: # Weitere Subpages der Seite eps
eps: { title: "translate:eps", subPath: "pages/EXTENSIONPOINTS.md" }
eplist: { title: "translate:eplist" }
logfile: { title: "translate:logfile" }
hidden:
title: "translate:hidden_page"
icon: rex-icon fa-ban
subPath: "pages/DESCRIPTION.md"
hidden: true # Versteckte Page, nur als Beispiel
# Logfile zusätzlich unter `System -> Logdateien` anzeigen
# `system/log/demo_addon` wird automatisch zu `system.log.demo_addon.php` aufgelöst
pages:
system/log/demo_addon:
title: "translate:navititle"
perm: admin[]
# Eigene Properties siehe https://redaxo.org/doku/master/addon-package#eigene
tableupdate.listEntries: 30 # Eigene Property für die Anzahl List-Einträge in der Tabellen-Verwaltung `tables.updatetable.php`
logfile.listEntries: 300 # Eigene Property für die Anzahl Einträge des Logfiles in `eps.logfile.php`
# Abhängigkeiten
# Anforderungen ans System oder anderere AddOns, um dieses AddOn installieren oder updaten zu können
requires:
redaxo: "^5.10" # benötigt mindestens REDAXO 5.10
packages:
media_manager: "^2.0.1" # benötigt mindestens das AddOn Media Manager 2.0.1
# Beispiel für ein Plugin Anforderung
# plugins:
# yform/rest: ">=3.4.0"
php:
version: ">=7.3, <9" # benötigt mindestens PHP 7.3
extensions: [gd, xml] # benötigt die PHP-Extensions GDlib und XML
# Plugins die automatisch installiert werden sollen
system_plugins:
- documentation
# Konflikte
# Verhindert die Installation und Updates, wenn AddOns die genannten Anforderungen erfüllen
# Siehe auch https://github.com/FriendsOfREDAXO/cache_warmup/pull/55#issuecomment-280906737
conflicts:
packages:
media_manager: ">=3" # Ist Media Manager in Version 3 vorhanden, führt das zum Konflikt mit diesem AddOn
# Installer (ab REX 5.7)
# Angabe von Ordnern und Dateien, die vom Installer ausgelassen werden sollen, wenn ein Release veröffentlicht wird
# Siehe auch https://github.com/redaxo/redaxo/pull/2352
installer_ignore:
- node_modules
- .env