Heute, 08:32 - [DEV] MP-Help - Plugin Improvement (joe128)
Ich finde die Idee einer generellen Hilfe für Plugins sehr gut, und finde auch dass jedes komplexere Plugin eine Hilfe benötigt.
Deswegen habe ich mir ein paar Gedanken dazu gemacht, wie man das Plugin verbessern könnte.
.) Localized Help
Es ist zwar ein "gettext" implementiert, nur habe ich keine Möglichkeit gefunden, dem Plugin ein binding auf das benutzende Plugin beizubringen. Davon abgesehen ist es glaube ich nicht konfortabel, wenn man die übersetzungen des xml-files in die pot-Datei mergen muss.
Deshalb dachte ich mir, dass die Text-Tags zusätzlich ein language-Attribut bekommen sollten, das dann zur Laufzeit ausgelesen werden kann. Dies müsste für die Nodes "Text" und "Title" implementiert werden. Als Fallback müsste jener Tag ohne language-Attribut bzw. jener mit einem "EN"-Tag verwendet werden.
.) Page-Index
Jede Seite sollte eine ID im xml-file definieren können, sodass man die Hilfe auch per "Anker" aufrufen kann. Existiert z.B. eine Seite "DETAIL-FUNCTION" könnte von Unter-Screens die Hilfe direkt zu dieser Seite aufgerufen werden.
Des Weiteren wäre dann eine generierte Index-Seite denkbar, von der man das gewünschte Topic per Schnell-wahl (1,2,3, ... rot, grün, ...) auswählen kann.
.) Skin-Improvements
sind relativ simple:
.) Seite x von y anzeigen
.) auf die Desktop-Größe eingehen
Beispiel-XML
<mphelp>
<page title="Standardtitle" ID="INTRO"/>
<title language="de" value="Deutscher Titel"/>
<text value="Page-Txt"/>
<text language="de" value="Seiten-Text"/>
</page>
</mphelp>
Ich denke diese Änderungen wären ohne viel impact auf bestehende Plugins umsetzbar.
Was hält die Dev-Community von diesen Verbesserungen? [zum Beitrag]
Ich finde die Idee einer generellen Hilfe für Plugins sehr gut, und finde auch dass jedes komplexere Plugin eine Hilfe benötigt.
Deswegen habe ich mir ein paar Gedanken dazu gemacht, wie man das Plugin verbessern könnte.
.) Localized Help
Es ist zwar ein "gettext" implementiert, nur habe ich keine Möglichkeit gefunden, dem Plugin ein binding auf das benutzende Plugin beizubringen. Davon abgesehen ist es glaube ich nicht konfortabel, wenn man die übersetzungen des xml-files in die pot-Datei mergen muss.
Deshalb dachte ich mir, dass die Text-Tags zusätzlich ein language-Attribut bekommen sollten, das dann zur Laufzeit ausgelesen werden kann. Dies müsste für die Nodes "Text" und "Title" implementiert werden. Als Fallback müsste jener Tag ohne language-Attribut bzw. jener mit einem "EN"-Tag verwendet werden.
.) Page-Index
Jede Seite sollte eine ID im xml-file definieren können, sodass man die Hilfe auch per "Anker" aufrufen kann. Existiert z.B. eine Seite "DETAIL-FUNCTION" könnte von Unter-Screens die Hilfe direkt zu dieser Seite aufgerufen werden.
Des Weiteren wäre dann eine generierte Index-Seite denkbar, von der man das gewünschte Topic per Schnell-wahl (1,2,3, ... rot, grün, ...) auswählen kann.
.) Skin-Improvements
sind relativ simple:
.) Seite x von y anzeigen
.) auf die Desktop-Größe eingehen
Beispiel-XML
<mphelp>
<page title="Standardtitle" ID="INTRO"/>
<title language="de" value="Deutscher Titel"/>
<text value="Page-Txt"/>
<text language="de" value="Seiten-Text"/>
</page>
</mphelp>
Ich denke diese Änderungen wären ohne viel impact auf bestehende Plugins umsetzbar.
Was hält die Dev-Community von diesen Verbesserungen? [zum Beitrag]