Archiv:Integration einer Hilfe in DSM 4.0-5.0 - Versionsgeschichte

Tommes: Tommes verschob die Seite Integration einer Hilfe in DSM 4.0-5.0 nach Archiv:Integration einer Hilfe in DSM 4.0-5.0

2025-03-15T07:21:02Z

Tommes verschob die Seite Integration einer Hilfe in DSM 4.0-5.0 nach Archiv:Integration einer Hilfe in DSM 4.0-5.0

← Nächstältere Version	Version vom 15. März 2025, 07:21 Uhr
(kein Unterschied)

imported>QTip: Erweitert: Test der Hilfe-Seiten

2017-04-07T18:35:50Z

Erweitert: Test der Hilfe-Seiten

← Nächstältere Version		Version vom 7. April 2017, 18:35 Uhr
Zeile 1:		Zeile 1:
	~~;'**** in Bearbeitung ***'~~

	==Einleitung==		==Einleitung==
	Ich zeige euch hier am Beispiel vom DDNS updater wie man leicht seine eigene Hilfe in die DSM 4.0 - 5.0 Hilfe integriert.<br>		Ich zeige euch hier am Beispiel vom DDNS updater wie man leicht seine eigene Hilfe in die DSM 4.0 - 5.0 Hilfe integriert.<br>
Zeile 177:		Zeile 175:
	* HTML-Seiten erstellen und in die angelegte Verzeichnisstruktur sichern		* HTML-Seiten erstellen und in die angelegte Verzeichnisstruktur sichern

	==~~Test der Hilfe~~-~~Seiten~~==		==Index-DB erzeugen==

	~~'''ACHTUNG Wird der Aufruf ohne die Option -n benutzt, wird die Index-DB zusätzlich in die DSM Index-DB migriert!!!'''<br>~~

	Damit wir die erstellten Hilfeseiten auch in der DSM-Hilfe sehen, muss der Indexer die Indizes in eine Index-DB schreiben und für jede gefundene Sprache ein TOC im JSON-Format anlegen. Die TOC befinden sich anschließend im Verzeichnis ".helptoc/<Wert_des_Parameters_app_der_helptoc.conf>" des Anwendungsverzeichnisses. Ab DSM 4.0 hat sich die Art der Integration ein wenig geändert, es wird nun eine anwendungsspezifische Index-DB im Verzeichnis indexdb des Anwendungsverzeichnisses erzeugt. Das Hinzufügen/Entfernen wird nun mittels zwei neuer Befehle durchgeführt (siehe [[#Benutzung in Installationspaketen (SPK)]])		Damit wir die erstellten Hilfeseiten auch in der DSM-Hilfe sehen, muss der Indexer die Indizes in eine Index-DB schreiben und für jede gefundene Sprache ein TOC im JSON-Format anlegen. Die TOC befinden sich anschließend im Verzeichnis ".helptoc/<Wert_des_Parameters_app_der_helptoc.conf>" des Anwendungsverzeichnisses. Ab DSM 4.0 hat sich die Art der Integration ein wenig geändert, es wird nun eine anwendungsspezifische Index-DB im Verzeichnis indexdb des Anwendungsverzeichnisses erzeugt. Das Hinzufügen/Entfernen wird nun mittels zwei neuer Befehle durchgeführt (siehe [[#Benutzung in Installationspaketen (SPK)]])

	Falls nicht schon geschehen, melden wir uns per telnet oder ssh als root auf der DiskStation an. Der Aufruf vom Indexer ist der folgende:<br>		'''ACHTUNG Wird der Aufruf ohne die Option -n benutzt, wird die Index-DB zusätzlich in die DSM Index-DB migriert!!!'''<br>Falls nicht schon geschehen, melden wir uns per telnet oder ssh als root auf der DiskStation an. Der Aufruf vom Indexer ist der folgende:<br>
	<code>/usr/bin/php -n -d safe_mode_exec_dir=/usr/syno/bin /usr/syno/synoman/webman/modules/Indexer/indexer.php -n -p /usr/syno/synoman/webman/3rdparty/<'''Anwendungsverzeichnis'''></code>		<code>/usr/bin/php -n -d safe_mode_exec_dir=/usr/syno/bin /usr/syno/synoman/webman/modules/Indexer/indexer.php -n -p /usr/syno/synoman/webman/3rdparty/<'''Anwendungsverzeichnis'''></code>

Zeile 197:		Zeile 192:
	Der Indexer sollte nun laufen und die entsprechenden Indizes und TOC erzeugen. Die Fehlermeldungen "No localized strings for...", "File not found:" und "Can't open file..." könnt ihr ignorieren, solange es sich nicht um eure erstellten Sprachen handelt.<br>		Der Indexer sollte nun laufen und die entsprechenden Indizes und TOC erzeugen. Die Fehlermeldungen "No localized strings for...", "File not found:" und "Can't open file..." könnt ihr ignorieren, solange es sich nicht um eure erstellten Sprachen handelt.<br>

	~~Im Anschluss muss noch~~ der ~~folgende~~ Befehl ~~abgesetzt~~ werden:<br>		Den Indexer müsst ihr nur erneut aufrufen, wenn ihr Zweige hinzugefügt/entfernt oder die Titel/Inhalte der Zweige geändert habt. Um die Änderungen dann in die Index-DB zu übernehmen, reicht ein erneuter Aufruf. Der Indexer erkennt selbstständig das Vorhandensein von Einträgen und aktualisiert diese dann nur. Erkennen kann man dies am Text "records (added, replaced, deleted)" = (0, '''x''', 0). ('''x''' = Anzahl)

			Erzeugte Verzeichnisse indexdb und .helptoc dem Paket hinzufügen, nicht benötigte Sprachordner im Verzeichnis indexdb können bedenkenlos gelöscht werden.

			==Test der Hilfe-Seiten==
			Mit dem folgenden Befehl kann die Hilfe zum Testen migrieren werden:<br>
	<code>/usr/syno/bin/pkgindexer_add /usr/syno/synoman/webman/3rdparty/ddnsupdater/helptoc.conf /usr/syno/synoman/webman/3rdparty/ddnsupdater/indexdb/helpindexdb</code><br>		<code>/usr/syno/bin/pkgindexer_add /usr/syno/synoman/webman/3rdparty/ddnsupdater/helptoc.conf /usr/syno/synoman/webman/3rdparty/ddnsupdater/indexdb/helpindexdb</code><br>
	Damit wird die erzeugte anwendungsspezifische Index-DB in die DSM-eigene Index-DB migriert.		Damit wird die erzeugte anwendungsspezifische Index-DB in die DSM-eigene Index-DB migriert.

	Nach Aufruf des DSM-Hilfe-Browsers und Umschaltung der Quelle im Menü "Optionen - Quelle" auf "Offline" sollte ein neuer Zweig mit eurer Hilfe zu sehen sein. Prüft alle Zweige und beseitigt eventuelle Fehler in den Hilfe-Dateien. Den Indexer müsst ihr nur erneut aufrufen, wenn ihr Zweige hinzugefügt/entfernt oder die Titel/Inhalte der Zweige geändert habt. Um die Änderungen dann in die Index-DB zu übernehmen, reicht ein erneuter Aufruf. Der Indexer erkennt selbstständig das Vorhandensein von Einträgen und aktualisiert diese dann nur. Erkennen kann man dies am Text "records (added, replaced, deleted)" = (0, '''x''', 0). ('''x''' = Anzahl)		Nach Aufruf des DSM-Hilfe-Browsers und Umschaltung der Quelle im Menü "Optionen - Quelle" auf "Offline" sollte ein neuer Zweig mit eurer Hilfe zu sehen sein. Prüft alle Zweige und beseitigt eventuelle Fehler in den Hilfe-Dateien.

	Der Aufruf der Hilfe kann nun ebenfalls aus der Anwendung über das '''?''' im Titel des Fensters durchgeführt werden.		Der Aufruf der Hilfe kann nun ebenfalls aus der Anwendung über das '''?''' im Titel des Fensters durchgeführt werden.
Zeile 208:		Zeile 208:
	Die folgenden Dateien/Verzeichnisse müssen dem Paket zusätzlich mitgegeben werden:		Die folgenden Dateien/Verzeichnisse müssen dem Paket zusätzlich mitgegeben werden:

	package.tgz		in package.tgz
	* /.helptoc		* /.helptoc
	* /help		* /help

imported>QTip: /* Benutzung in Installationspaketen (SPK) */

2017-04-06T16:54:58Z

Benutzung in Installationspaketen (SPK)

← Nächstältere Version		Version vom 6. April 2017, 16:54 Uhr
Zeile 207:		Zeile 207:
	==Benutzung in Installationspaketen (SPK)==		==Benutzung in Installationspaketen (SPK)==
	Die folgenden Dateien/Verzeichnisse müssen dem Paket zusätzlich mitgegeben werden:		Die folgenden Dateien/Verzeichnisse müssen dem Paket zusätzlich mitgegeben werden:

			package.tgz
	* /.helptoc		* /.helptoc
	* /help		* /help

imported>QTip: /* Erklärung der Schlüsselwörter */

2017-04-06T16:29:05Z

Erklärung der Schlüsselwörter

← Nächstältere Version		Version vom 6. April 2017, 16:29 Uhr
Zeile 75:		Zeile 75:
	\|app\|\|Name der Applikation, bei 3rdparty Apps immer SYNO.SDS._ThirdParty.App.<Anwendungsname> (Name wie er in der Datei INFO hinter "package=" steht oder der Verzeichnisname)\|\|alphanumerisch		\|app\|\|Name der Applikation, bei 3rdparty Apps immer SYNO.SDS._ThirdParty.App.<Anwendungsname> (Name wie er in der Datei INFO hinter "package=" steht oder der Verzeichnisname)\|\|alphanumerisch
	\|-		\|-
	\|title\|\|Der Titel eines Eintrags/Zweiges\|\|alphanumerisch		\|title*\|\|Der Titel eines Eintrags/Zweiges\|\|alphanumerisch
	\|-		\|-
	\|stringset\|\|Bestimmt den Ort der Sprachtextdateien mit denen die Platzhalter gefüllt werden\|\|alphanumerisch		\|stringset*\|\|Bestimmt den Ort der Sprachtextdateien mit denen die Platzhalter gefüllt werden\|\|alphanumerisch
	\|-		\|-
	\|helpset\|\|Bestimmt den Ort an dem sich die erzeugten HTML Hilfedateien befinden\|\|alphanumerisch		\|helpset\|\|Bestimmt den Ort an dem sich die erzeugten HTML Hilfedateien befinden\|\|alphanumerisch
Zeile 83:		Zeile 83:
	\|toc\|\|Hier beginnt der Inhalt des Hilfebaumes (Table of Contents)\|\|		\|toc\|\|Hier beginnt der Inhalt des Hilfebaumes (Table of Contents)\|\|
	\|-		\|-
	\|content\|\|Inhalt, Pfad zur HTML-Datei, relativ zum Verzeichnis /usr/syno/synoman/webman/help/<Sprachkürzel>\|\|alphanumerisch		\|content*\|\|Inhalt, Pfad zur HTML-Datei, relativ zum Verzeichnis /usr/syno/synoman/webman/help/<Sprachkürzel>\|\|alphanumerisch
	\|-		\|-
	\|nodes\|\|Beginn eines Zweiges im Hilfebaum\|\|		\|nodes\|\|Beginn eines Zweiges im Hilfebaum\|\|
	\|}		\|}* notwendig

	Fassen wir zusammen:		Fassen wir zusammen:

imported>QTip: /* Benutzung in Installationspaketen (SPK) */ Scripts angepasst

2017-04-05T18:32:08Z

Benutzung in Installationspaketen (SPK): Scripts angepasst

← Nächstältere Version		Version vom 5. April 2017, 18:32 Uhr
Zeile 217:		Zeile 217:
	DSMBUILD=`/bin/get_key_value /etc.defaults/VERSION buildnumber`		DSMBUILD=`/bin/get_key_value /etc.defaults/VERSION buildnumber`
	APPHOME="/usr/syno/synoman/webman/3rdparty/<Anwendungsname>"		APPHOME="/usr/syno/synoman/webman/3rdparty/<Anwendungsname>"
	if [ $DSMBUILD -eq 2198 -a $DSMBUILD -le ~~5358~~ ]; then		if [ $DSMBUILD -ge 2198 -a $DSMBUILD -le 4627 ]; then
	/usr/syno/bin/pkgindexer_add $APPHOME/helptoc.conf $APPHOME/indexdb/helpindexdb		/usr/syno/bin/pkgindexer_add $APPHOME/helptoc.conf $APPHOME/indexdb/helpindexdb
	/bin/sed '-e /<Anwendungsname>/d' < /usr/syno/synoman/indexdb/help.catalog > /usr/syno/synoman/indexdb/help.catalog.bak		/bin/sed '-e /<Anwendungsname>/d' < /usr/syno/synoman/indexdb/help.catalog > /usr/syno/synoman/indexdb/help.catalog.bak
Zeile 225:		Zeile 225:
	fi		fi
	</pre>		</pre>
	Zuerst holt sich das Script die DSM Buildnummer. Ist die Buildnummer größer/gleich 2198 (DSM 4.0) und kleiner/gleich ~~5358~~ (DSM 5.1), dann wird der Befehl "pkgindexer_add" mit den nötigen Parametern aufgerufen und die anwendungsspezifische Index-DB in die DSM-eigene Index-DB migriert.		Zuerst holt sich das Script die DSM Buildnummer. Ist die Buildnummer größer/gleich 2198 (DSM 4.0) und kleiner/gleich 4627 (DSM 5.0), dann wird der Befehl "pkgindexer_add" mit den nötigen Parametern aufgerufen und die anwendungsspezifische Index-DB in die DSM-eigene Index-DB migriert.

	===Deinstallation===		===Deinstallation===
	In meinen Tests stellte sich heraus, dass das Entfernen der Indizes aus der Index-DB bei der Deinstallation zu einem Timeout führt und die Deinstallation mit einer Fehlermeldung abbricht. Der Trick ist nun, die helptoc.conf zu verschieben, damit der Paketmanager nicht selbständig den Indexer aufruft. Dieser Schritt wird nun von uns mit dem folgendem Script im preuninst-Teil durchgeführt, da im postuninst-Teil das Verzeichnis entfernt wird:
	<pre>		<pre>
	DSMBUILD=`/bin/get_key_value /etc.defaults/VERSION buildnumber`		DSMBUILD=`/bin/get_key_value /etc.defaults/VERSION buildnumber`
	APPHOME="/usr/syno/synoman/webman/3rdparty/<Anwendungsname>"		APPHOME="/usr/syno/synoman/webman/3rdparty/<Anwendungsname>"
	if [ $DSMBUILD -eq 2198 -a $DSMBUILD -le ~~5358~~ ]; then		if [ $DSMBUILD -ge 2198 -a $DSMBUILD -le 4627 ]; then
	/usr/syno/bin/pkgindexer_del $APPHOME/helptoc.conf $APPHOME/indexdb/helpindexdb		/usr/syno/bin/pkgindexer_del $APPHOME/helptoc.conf $APPHOME/indexdb/helpindexdb
	fi		fi
	</pre>		</pre>
	Am Anfang wird wieder die aktuelle DSM Buildnummer ermittelt. Ist der Wert größer/gleich 2198 (DSM 4.0) und kleiner/gleich ~~5358~~ (DSM 5.1), dann wird der Befehl "pkgindexer_del" mit den nötigen Parametern aufgerufen und die anwendungsspezifische Index-DB aus der DSM-eigenen Index-DB demigriert.		Am Anfang wird wieder die aktuelle DSM Buildnummer ermittelt. Ist der Wert größer/gleich 2198 (DSM 4.0) und kleiner/gleich 4627 (DSM 5.0), dann wird der Befehl "pkgindexer_del" mit den nötigen Parametern aufgerufen und die anwendungsspezifische Index-DB aus der DSM-eigenen Index-DB demigriert.

imported>QTip: /* Test der Hilfe-Seiten */

2017-04-05T18:25:17Z

Test der Hilfe-Seiten

← Nächstältere Version		Version vom 5. April 2017, 18:25 Uhr
Zeile 195:		Zeile 195:
	Am Beispiel für den DDNS updater müßte die Zeile folgendermaßen aussehen:<br>		Am Beispiel für den DDNS updater müßte die Zeile folgendermaßen aussehen:<br>
	<code>/usr/bin/php -n -d safe_mode_exec_dir=/usr/syno/bin /usr/syno/synoman/webman/modules/Indexer/indexer.php -n -p /usr/syno/synoman/webman/3rdparty/ddnsupdater</code><br>		<code>/usr/bin/php -n -d safe_mode_exec_dir=/usr/syno/bin /usr/syno/synoman/webman/modules/Indexer/indexer.php -n -p /usr/syno/synoman/webman/3rdparty/ddnsupdater</code><br>
	Der Indexer sollte nun laufen und die entsprechenden Indizes und TOC erzeugen. Die Fehlermeldungen "No localized strings for..." ~~und~~ "File not found:" könnt ihr ignorieren, solange es sich nicht um eure erstellten Sprachen handelt.<br>		Der Indexer sollte nun laufen und die entsprechenden Indizes und TOC erzeugen. Die Fehlermeldungen "No localized strings for...", "File not found:" und "Can't open file..." könnt ihr ignorieren, solange es sich nicht um eure erstellten Sprachen handelt.<br>

	Im Anschluss muss noch der folgende Befehl abgesetzt werden:<br>		Im Anschluss muss noch der folgende Befehl abgesetzt werden:<br>

imported>QTip: /* Hilfe-Seiten erstellen */ Quelltext für Kopfteil angepasst

2017-04-05T18:07:09Z

Hilfe-Seiten erstellen: Quelltext für Kopfteil angepasst

← Nächstältere Version		Version vom 5. April 2017, 18:07 Uhr
Zeile 158:		Zeile 158:
	<script type="text/javascript" src="../../scrollbar/flexcroll.js"></script>		<script type="text/javascript" src="../../scrollbar/flexcroll.js"></script>
	<script type="text/javascript" src="../../scrollbar/initFlexcroll.js"></script>		<script type="text/javascript" src="../../scrollbar/initFlexcroll.js"></script>

			<title><Anwendungsname></title>
	</head>		</head>
	</pre>		</pre>

imported>QTip: /* Einleitung */

2017-04-05T18:00:57Z

Einleitung

← Nächstältere Version		Version vom 5. April 2017, 18:00 Uhr
Zeile 2:		Zeile 2:

	==Einleitung==		==Einleitung==
	Ich zeige euch hier am Beispiel vom DDNS updater wie man leicht seine eigene Hilfe in die DSM 4.0 - 5.1 Hilfe integriert.<br>		Ich zeige euch hier am Beispiel vom DDNS updater wie man leicht seine eigene Hilfe in die DSM 4.0 - 5.0 Hilfe integriert.<br>
	Als erstes überlegen wir uns den strukturellen Aufbau unserer Hilfe, welche Baumstruktur wir benötigen und was dort hinein soll.		Als erstes überlegen wir uns den strukturellen Aufbau unserer Hilfe, welche Baumstruktur wir benötigen und was dort hinein soll.

imported>QTip: QTip verschob die Seite Integration einer Hilfe in DSM 4.0-5.1 nach Integration einer Hilfe in DSM 4.0-5.0

2017-04-05T18:00:31Z

QTip verschob die Seite Integration einer Hilfe in DSM 4.0-5.1 nach Integration einer Hilfe in DSM 4.0-5.0

← Nächstältere Version	Version vom 5. April 2017, 18:00 Uhr
(kein Unterschied)

imported>QTip: /* Test der Hilfe-Seiten */

2017-04-05T17:38:04Z

Test der Hilfe-Seiten

← Nächstältere Version		Version vom 5. April 2017, 17:38 Uhr
Zeile 195:		Zeile 195:
	Der Indexer sollte nun laufen und die entsprechenden Indizes und TOC erzeugen. Die Fehlermeldungen "No localized strings for..." und "File not found:" könnt ihr ignorieren, solange es sich nicht um eure erstellten Sprachen handelt.<br>		Der Indexer sollte nun laufen und die entsprechenden Indizes und TOC erzeugen. Die Fehlermeldungen "No localized strings for..." und "File not found:" könnt ihr ignorieren, solange es sich nicht um eure erstellten Sprachen handelt.<br>

	Nach Aufruf des DSM-Hilfe-Browsers sollte ein neuer Zweig mit eurer Hilfe zu sehen sein. Prüft alle Zweige und beseitigt eventuelle Fehler in den Hilfe-Dateien. Den Indexer müsst ihr nur erneut aufrufen, wenn ihr Zweige hinzugefügt/entfernt oder die Titel/Inhalte der Zweige geändert habt. Um die Änderungen dann in die Index-DB zu übernehmen, reicht ein erneuter Aufruf. Der Indexer erkennt selbstständig das Vorhandensein von Einträgen und aktualisiert diese dann nur. Erkennen kann man dies am Text "records (added, replaced, deleted)" = (0, '''x''', 0). ('''x''' = Anzahl)		Im Anschluss muss noch der folgende Befehl abgesetzt werden:<br>
			<code>/usr/syno/bin/pkgindexer_add /usr/syno/synoman/webman/3rdparty/ddnsupdater/helptoc.conf /usr/syno/synoman/webman/3rdparty/ddnsupdater/indexdb/helpindexdb</code><br>
			Damit wird die erzeugte anwendungsspezifische Index-DB in die DSM-eigene Index-DB migriert.

			Nach Aufruf des DSM-Hilfe-Browsers und Umschaltung der Quelle im Menü "Optionen - Quelle" auf "Offline" sollte ein neuer Zweig mit eurer Hilfe zu sehen sein. Prüft alle Zweige und beseitigt eventuelle Fehler in den Hilfe-Dateien. Den Indexer müsst ihr nur erneut aufrufen, wenn ihr Zweige hinzugefügt/entfernt oder die Titel/Inhalte der Zweige geändert habt. Um die Änderungen dann in die Index-DB zu übernehmen, reicht ein erneuter Aufruf. Der Indexer erkennt selbstständig das Vorhandensein von Einträgen und aktualisiert diese dann nur. Erkennen kann man dies am Text "records (added, replaced, deleted)" = (0, '''x''', 0). ('''x''' = Anzahl)

			Der Aufruf der Hilfe kann nun ebenfalls aus der Anwendung über das '''?''' im Titel des Fensters durchgeführt werden.

	==Benutzung in Installationspaketen (SPK)==		==Benutzung in Installationspaketen (SPK)==