Microsoft Dynamics NAV 2009 HTML Help Toolkit Dokumentation
20. August 2010 15:01
Hallo zusammen,
da ich nun seid knapp einer Woche mich mit dem Thema auseinander gesetzt habe und die letzte Doku recht alt, hab ich mir die Mühe gemacht mal eine neue Doku zu schreiben.
Diese Doku befasst sich speziell mit der Onlinehilfe für Navision 6 bzw 2009 für den Classic Client. Ich hoffe sie hilft euch allen weiter, die es interessiert.
Kommentare und konsturktive Kritik gerne erwünscht.
Mit freundlichen Grüßen
iPeon alias André
da ich nun seid knapp einer Woche mich mit dem Thema auseinander gesetzt habe und die letzte Doku recht alt, hab ich mir die Mühe gemacht mal eine neue Doku zu schreiben.
Diese Doku befasst sich speziell mit der Onlinehilfe für Navision 6 bzw 2009 für den Classic Client. Ich hoffe sie hilft euch allen weiter, die es interessiert.
Kommentare und konsturktive Kritik gerne erwünscht.
Mit freundlichen Grüßen
iPeon alias André
Du hast keine ausreichende Berechtigung, um die Dateianhänge dieses Beitrags anzusehen.
Zuletzt geändert von iPeon am 31. August 2010 14:10, insgesamt 3-mal geändert.
Re: Microsoft Dynamics NAV 2009 HTML Help Toolkit Dokumentat
20. August 2010 15:35
Danke für die Mühe, die du dir gemacht hast! 
Ich denke, davon werden noch viele profitieren.
Ich denke, davon werden noch viele profitieren.
Re: Microsoft Dynamics NAV 2009 HTML Help Toolkit Dokumentat
26. August 2010 17:58
Hallo zusammen,
Ich habe einen kleinen, aber wichtigen Punkt vergessen in der Dokumentation.
Es geht dabei um folgende Fehlermeldung die auftaucht:
"ERROR: [ArgumentException] One of the values provided to Help Builder is not valid. Check config files. Help Builder will stop processing. More
information: startIndex darf nicht länger als die Länge der Zeichenfolge sein.
Parametername: startIndex"
Diese Fehlermeldung kann einfach im Schritt 2 - Erstellung eines Hilfeprojekts und deren Inhalt abgefangen werden. Wie ist ganz einfach:
Im Reiter Contents, des HTML Workshops, musst ein neuen Header anfügen werden. Das ist das Buch auf der linken Seite in der Toolbox. Es kommt eine Meldung ob dieser Header an den Anfang der Table of Content gelegen werden soll., welche man mit "Ja" beantwortet. Ordne dann den Punkt "Tables, Reports & Batch Jobs" über die Pfeile, welche sich ebenfalls auf der linken Seite in der Toolbox befinden, unter den neuen Header an. Dann wie beschrieben weiter.
*EDIT* Update der Doku!
Mit freundlichen Grüßen
iPeon
Ich habe einen kleinen, aber wichtigen Punkt vergessen in der Dokumentation.
Es geht dabei um folgende Fehlermeldung die auftaucht:
"ERROR: [ArgumentException] One of the values provided to Help Builder is not valid. Check config files. Help Builder will stop processing. More
information: startIndex darf nicht länger als die Länge der Zeichenfolge sein.
Parametername: startIndex"
Diese Fehlermeldung kann einfach im Schritt 2 - Erstellung eines Hilfeprojekts und deren Inhalt abgefangen werden. Wie ist ganz einfach:
Im Reiter Contents, des HTML Workshops, musst ein neuen Header anfügen werden. Das ist das Buch auf der linken Seite in der Toolbox. Es kommt eine Meldung ob dieser Header an den Anfang der Table of Content gelegen werden soll., welche man mit "Ja" beantwortet. Ordne dann den Punkt "Tables, Reports & Batch Jobs" über die Pfeile, welche sich ebenfalls auf der linken Seite in der Toolbox befinden, unter den neuen Header an. Dann wie beschrieben weiter.
*EDIT* Update der Doku!
Mit freundlichen Grüßen
iPeon
Re: Microsoft Dynamics NAV 2009 HTML Help Toolkit Dokumentat
31. August 2010 14:07
Nochmal ein kleines Update meinerseits zur Hilfestellungen bei der Erstellung einer HTML Help File.
Anbei gibt es nun einen deutschsprachiges Language Pack, welches eine Javascript Datei beinhaltet und eine xml Datei.
Zur XML Datei:
Die XML Datei ist im Grunde die config.default.xml Datei des Help Builders. Diese Datei beinhaltet nun alle deutschen Texte und ist dem Standart von NAV 2009 angepasst. Die meisten Zusatztexte sind also einfach weg, weil Sie im Standart auch nicht drin sind. Aufgepasst. NAV 2009 Classis Client Hilfe hat in der Addon Datenbankhilfe eine andere Struktur, was das Heading der Hilfedateien angeht. Danach bin ich nicht gegangen.
Zur Javascript Datei. Die Javascriptdatei ist die Feedbackfunktion der Hilfe. Sie beinhaltet alle Texte (auf Deutsch) und gibt eine die Microsoft Feedback Funktion wieder. Was vermütlich meist vergessen wird und auch überhaupt nicht in der eigenen Doku erwähnt wird vom Help Builder ist, das die Feedbackfunktion letzendlich ein Email erstellt, an Microsoft. Das sollte nicht passieren, da die herzlich wenig damit anfangen können ob die selbst geschriebene Dokumentation gut oder schlecht sei. Sie möchten zwar gerne eine Email erhalten, wie der Comment zu lesen ist, aber anfangen können Sie damit immer noch nichts. Deshalb öffnet kurz die Javascriptdatei mit Notepad. Dort stehen zwei Werte in Zeile 5 & 6.
Danach bennet Ihr die Datei um in Feedback.js und speichert Sie im Shared Ordner worauf der Help Builder zugreift. Damit sollte eure Hilfedatei komplett deutsch sein und Ihr bekommt euer Feedback. Ganz nach dem Styleguide ;)
Mit freundlichen Grüßen
iPeon alias André
Anbei gibt es nun einen deutschsprachiges Language Pack, welches eine Javascript Datei beinhaltet und eine xml Datei.
Zur XML Datei:
Die XML Datei ist im Grunde die config.default.xml Datei des Help Builders. Diese Datei beinhaltet nun alle deutschen Texte und ist dem Standart von NAV 2009 angepasst. Die meisten Zusatztexte sind also einfach weg, weil Sie im Standart auch nicht drin sind. Aufgepasst. NAV 2009 Classis Client Hilfe hat in der Addon Datenbankhilfe eine andere Struktur, was das Heading der Hilfedateien angeht. Danach bin ich nicht gegangen.
Zur Javascript Datei. Die Javascriptdatei ist die Feedbackfunktion der Hilfe. Sie beinhaltet alle Texte (auf Deutsch) und gibt eine die Microsoft Feedback Funktion wieder. Was vermütlich meist vergessen wird und auch überhaupt nicht in der eigenen Doku erwähnt wird vom Help Builder ist, das die Feedbackfunktion letzendlich ein Email erstellt, an Microsoft. Das sollte nicht passieren, da die herzlich wenig damit anfangen können ob die selbst geschriebene Dokumentation gut oder schlecht sei. Sie möchten zwar gerne eine Email erhalten, wie der Comment zu lesen ist, aber anfangen können Sie damit immer noch nichts. Deshalb öffnet kurz die Javascriptdatei mit Notepad. Dort stehen zwei Werte in Zeile 5 & 6.
- Code:
var sPartner = "{Ihr Firmenname}";//change to your company name
var sRecipient = "mailto:info@ihre-firma.de";//append your company's email address. Please leave the Microsoft address as well
Danach bennet Ihr die Datei um in Feedback.js und speichert Sie im Shared Ordner worauf der Help Builder zugreift. Damit sollte eure Hilfedatei komplett deutsch sein und Ihr bekommt euer Feedback. Ganz nach dem Styleguide ;)
Mit freundlichen Grüßen
iPeon alias André
Re: Microsoft Dynamics NAV 2009 HTML Help Toolkit Dokumentat
15. Februar 2011 13:57
Hallo,
gibt es zu Weilen eventuell eine geänderte Version der Doku für den RTC?
Die Doku ansich ist sehr gut, aber selbst wenn ich die Schritt für Schritt befolge, erreiche ich nicht das gewünschte Ziel. Insbesondere die Sache mit der Index Dadei funktioniert überhaupt nicht. Ich kann auch leider nun nach 2 Wochen grübeln und versuchen nicht mehr genau wieder geben, was ich schon alles gemacht habe.
Das Problem ist, dass die Index Datei, die ja irgendwie in der Doku schon vorhanden sein muss, nicht erstellt wird. Dann habe ich um weiter zu kommen, eine vom tool erstellen lassen. Die bliebe aber Permanent leer. Auch nach kompilieren mit Option auf AutoIndex/AutoKeyword. Theoretisch muss es ja machbar sein, ein Index auch manuell zu erstellen, da wir aber ca. 25.000 htm-Files haben, versuche ich dem zu entgehen. Sonst bin ich mit meiner Ausbildung fertig und habe nur Hilfe erstellen gelernt ^^
Woran kann es liegen, dass die Index hhk nicht gefüllt wird?
Die Doku sagt, man solle beim erstellen des Projekts angeben welche files man schon hat, das ist zum einen das TOC zum anderen die htms. Dann ist es irgendwann erstellt, nach eintragen aller htms, was ewig dauert, da immer nur ca. 500 auf einmal hinzugefügt werden können und jeder klick in dem riesen Ordner knapp 2 Minuten braucht :(
So nun steht in der Doku, dass man im Reiter Projekt auf die Optionen gehen soll und dann den Index File erstellen soll. Da kann man ja aber ledgilich angeben. Wenn man dann auf OK klickt, wird der nicht angelegt. Ein Index wurde bei mir bisher immer nur erstellt, wenn ich auf dem Reiter index geklickt habe, das Projekt dann festgestellt hatte, dass kein Index vorliegt und den dann generiert hat. Dieser Index ist aber immer leer. :(
Ich glaube auch, dass es daran liegt, was als weiterführendes Problem entsteht.
Wenn man dann im RTC die Hilfe aktiviert, ist die nicht Feldspezifisch, sondern lediglich Objectspezifisch, da erscheint dann die Hilfe zur jeweiligen Page, mehr leider nicht. Dann kommt es stellenweise vor, das ein Feldhilfe aufgerufen wird, die aber nicht zum gewählten Feld passt. Und so weiter.
Falls jemand ähnliche Probleme hatte, oder so schon sehen kann, wo der Fehler liegen kann, dann bitte nur her damit, ich muss das schnellst möglich fertig bekommen. Ich weiß nur langsam nicht mehr weiter, da ich schon seit ein paar Wochen nun dabei bin und einfach langsam die Ideen ausgehen.
Dann noch ein letztes, gibt es ein externes Tool, mit dem sich das alles realisieren lässt? Also nicht der MS Help Builder, sondern ein ganz anderes? RoboHelp ist mir bekannt, damit kam ich aber auch nicht so recht klar, da ich glaube, der kann das ganze nur für den CC und nicht für den RTC.
So wieder viel Text, aber ich hoffe, mir kann jemand helfen.
Vielen Dank schon mal im Voraus.
Lieben Gruß
Marcel
gibt es zu Weilen eventuell eine geänderte Version der Doku für den RTC?
Die Doku ansich ist sehr gut, aber selbst wenn ich die Schritt für Schritt befolge, erreiche ich nicht das gewünschte Ziel. Insbesondere die Sache mit der Index Dadei funktioniert überhaupt nicht. Ich kann auch leider nun nach 2 Wochen grübeln und versuchen nicht mehr genau wieder geben, was ich schon alles gemacht habe.
Das Problem ist, dass die Index Datei, die ja irgendwie in der Doku schon vorhanden sein muss, nicht erstellt wird. Dann habe ich um weiter zu kommen, eine vom tool erstellen lassen. Die bliebe aber Permanent leer. Auch nach kompilieren mit Option auf AutoIndex/AutoKeyword. Theoretisch muss es ja machbar sein, ein Index auch manuell zu erstellen, da wir aber ca. 25.000 htm-Files haben, versuche ich dem zu entgehen. Sonst bin ich mit meiner Ausbildung fertig und habe nur Hilfe erstellen gelernt ^^
Woran kann es liegen, dass die Index hhk nicht gefüllt wird?
Die Doku sagt, man solle beim erstellen des Projekts angeben welche files man schon hat, das ist zum einen das TOC zum anderen die htms. Dann ist es irgendwann erstellt, nach eintragen aller htms, was ewig dauert, da immer nur ca. 500 auf einmal hinzugefügt werden können und jeder klick in dem riesen Ordner knapp 2 Minuten braucht :(
So nun steht in der Doku, dass man im Reiter Projekt auf die Optionen gehen soll und dann den Index File erstellen soll. Da kann man ja aber ledgilich angeben. Wenn man dann auf OK klickt, wird der nicht angelegt. Ein Index wurde bei mir bisher immer nur erstellt, wenn ich auf dem Reiter index geklickt habe, das Projekt dann festgestellt hatte, dass kein Index vorliegt und den dann generiert hat. Dieser Index ist aber immer leer. :(
Ich glaube auch, dass es daran liegt, was als weiterführendes Problem entsteht.
Wenn man dann im RTC die Hilfe aktiviert, ist die nicht Feldspezifisch, sondern lediglich Objectspezifisch, da erscheint dann die Hilfe zur jeweiligen Page, mehr leider nicht. Dann kommt es stellenweise vor, das ein Feldhilfe aufgerufen wird, die aber nicht zum gewählten Feld passt. Und so weiter.
Falls jemand ähnliche Probleme hatte, oder so schon sehen kann, wo der Fehler liegen kann, dann bitte nur her damit, ich muss das schnellst möglich fertig bekommen. Ich weiß nur langsam nicht mehr weiter, da ich schon seit ein paar Wochen nun dabei bin und einfach langsam die Ideen ausgehen.
Dann noch ein letztes, gibt es ein externes Tool, mit dem sich das alles realisieren lässt? Also nicht der MS Help Builder, sondern ein ganz anderes? RoboHelp ist mir bekannt, damit kam ich aber auch nicht so recht klar, da ich glaube, der kann das ganze nur für den CC und nicht für den RTC.
So wieder viel Text, aber ich hoffe, mir kann jemand helfen.
Vielen Dank schon mal im Voraus.
Lieben Gruß
Marcel
Re: Microsoft Dynamics NAV 2009 HTML Help Toolkit Dokumentat
25. Oktober 2011 11:13
Tja das Thema OnlineHilfe scheint ja ein ziemlich heikles Thema zu sein. Einen kleinen Fehler meine ich aber in der Doku gefunden zu haben und zwar mit dem Feedback Script.
Und zwar wenn du deinen HilfeProjekt als addin_a usw. in Navision einbindest, nimmt er trotzdem das Standard Feedbackscript.
Rausfinden kann man das ganz leicht, indem man die schon eingebundene Hilfe sich anzeigen lässt und einmal eine FeedbackMail schreiben will. Dann geht die Mail an MS. Startet man jedoch die .chm Datei einfach so aus dem Verzeichniss heraus und erstellt eine FeedbackMail so geht diese geht an die Adresse, die man in das bearbeitete Script eingetragen hat.
Scheinbar interpretiert NAV diesen add_in (usw.) als wirkliches Addin und nicht als eigenständige OnlineHilfe. Hm genau kann ich das jetzt auch nicht erklären, jedoch sollte es behoben werden, wenn ihr der OnlineHilfe einen eigenen Namen gebt und dieses in die masterdatei eintragt.
@eLmoXis:
Das Problem mit dem beschränken auf ca. 500 Files hatte ich auch und es war schrecklich. Ich habs dann später mit einer .bat gelöst, die mir jeweils 500 Files in einen Ordner verschoben hat.
Hier einmal das Ding. Muss man sich noch ein wenig anpassen:
Einfach den Code kopieren und z.B. mit Notepad als .bat abspeichern. Dieser Batch packt nun ALLE htm Dateien, die sich in dem Ordner Source befinden in Unterorder, die er selbst erstellt mit dem Namen "Ordner 1","Ordner 2" usw. Bis es keine htm Files mehr in dem Ordner Source gibt. Relativ praktisch :)
Und zwar wenn du deinen HilfeProjekt als addin_a usw. in Navision einbindest, nimmt er trotzdem das Standard Feedbackscript.
Rausfinden kann man das ganz leicht, indem man die schon eingebundene Hilfe sich anzeigen lässt und einmal eine FeedbackMail schreiben will. Dann geht die Mail an MS. Startet man jedoch die .chm Datei einfach so aus dem Verzeichniss heraus und erstellt eine FeedbackMail so geht diese geht an die Adresse, die man in das bearbeitete Script eingetragen hat.
Scheinbar interpretiert NAV diesen add_in (usw.) als wirkliches Addin und nicht als eigenständige OnlineHilfe. Hm genau kann ich das jetzt auch nicht erklären, jedoch sollte es behoben werden, wenn ihr der OnlineHilfe einen eigenen Namen gebt und dieses in die masterdatei eintragt.
@eLmoXis:
Das Problem mit dem beschränken auf ca. 500 Files hatte ich auch und es war schrecklich. Ich habs dann später mit einer .bat gelöst, die mir jeweils 500 Files in einen Ordner verschoben hat.
Hier einmal das Ding. Muss man sich noch ein wenig anpassen:
- Code:
@echo off
setlocal enabledelayedexpansion
set "SrcDir=C:\MyHTMLHelp\Project\addin_a\Source"
set "FileType=htm"
set "nFiles=500"
set /a "Cntr=0"
:Loop
set "FilesAvailable="
for /f "tokens=1* delims=:" %%a in ('dir /b /a:-d "%SrcDir%\*.%FileType%" 2^>NUL ^| findstr /n "^"') do (
if %%a leq %nFiles% (
if %%a equ 1 (
set /a "Cntr+=1"
md "%SrcDir%\Ordner!Cntr!"
)
move "%SrcDir%\%%b" "%SrcDir%\Ordner!Cntr!\%%b"
set "FilesAvailable=1"
)
)
if defined FilesAvailable goto :Loop
Einfach den Code kopieren und z.B. mit Notepad als .bat abspeichern. Dieser Batch packt nun ALLE htm Dateien, die sich in dem Ordner Source befinden in Unterorder, die er selbst erstellt mit dem Namen "Ordner 1","Ordner 2" usw. Bis es keine htm Files mehr in dem Ordner Source gibt. Relativ praktisch :)