pluginbeschreibung und text formatierung

  1. wie addieren wir text in die “Pluginbeschreibung” tab in shopware-backend-frontend plugin “Öffnen” ding?
  2. wie formatieren wir diese text?
  3. wo ist die dokumentation dafür?

durch trial-and-error habe ich gefunden das wir können in plugin.xml die “description” tag benutzen, was als “Pluginbeschreibung” benutzt wird. aber diese erlaubt kein html…

hab versucht zbs. die “Pluginbeschreibung” in SwagPaymentPayPalUnified zu finden (weil es benutzt formatierung), es hat zbs. text “Produktinformation” drin. aber grep -rn 'Produktinformation' ~/meinshop/custom/plugins/SwagPaymentPayPalUnified/ findet keine treffer…

oder gibt es andere lösungen denn plugin user wichtige informationen über die plugin zu geben?
(in shopware! weil die plugins werden von uns für die entwickelt und installiert)

ps. wir sind noch auf shopware 5.4.x, falls das was aus macht…
pps. nein, unsere plugins sind nicht in shopware store.

Try: https://github.com/FriendsOfShopware/FroshPluginUploader

Gruß Heiner

@h_lohaus schrieb:

Try: https://github.com/FriendsOfShopware/FroshPluginUploader

was genau soll ich damit probieren?

ps. ich hätte wohl noch extra sagen müssen das unsere plugins werden auch nie in shopware store landen.

Die Logik da ist recht simpel - er nimmt die Beschreibung aus dem Store (= HTML) und wenn das Pugin nicht im Store ist, die aus der plugin.xml.

 

@Moritz Naczenski schrieb:

Die Logik da ist recht simpel - er nimmt die Beschreibung aus dem Store (= HTML) und wenn das Pugin nicht im Store ist, die aus der plugin.xml.

 

welche genaue tag in plugin.xml?
wie formatieren wir die text in diesen tag?

wenn nicht möglich, wie sonst können nicht-store plugins wichtige informationen an shop admins geben? (über shopware-backend-frontend!)

ps. wir sind shop betreiber, und schreiben plugins nur für unsere bedürfnisse. und die shop admins müssen wissen wie die plugin zu benutzen ist…

Ich würde sagen, es ist eher ein unüblicher Case, dass man über diesen Weg irgendeine form von wichtiger Information an den Shopbetreiber gibt. Es kann ja in deinem Case notwendig sein, aber i.d.R. erfolgt dies in Form einer Dokumentation (bspw. online oder intranet).

Unabhängig davon kannst du doch “description” in der plugin.xml nutzen und wenn du dich an die xml-Richtlinien hälst natürlich auch HTML nutzen. Mein Beispiel funktioniert einwandfrei:

        hallo
        ]]>

Das hat ja nix mit Shopware zu tun, dass man HTML in XML entsprechend Kennzeichnen muss.

1 „Gefällt mir“

hallo
]]>

perfect, danke!

FWIW, ich finde plugin dokumentation in der plugin viel nützlicher als irgendwo extern.

  • es ist für immer da
  • es ist immer für die richtige version
  • entwickler müssen keine 2 repos pflegen (oder extra wurst um docs irgendwo zu aktualisieren/versionieren)

die „Pluginbeschreibung“ ist halt das einzige was shopware-backend-frontend für uns dafür bietet, oder?
(natürlich ohne selber was zu basteln)

ne eigene button in shopware-backend-frontend plugin liste für „docs“ wäre schön, der einfach die lokale docs ordner in tab/dialog öffnet, oder so…