Komandozeilen Kompiler
vorheriges Thema  nächstes Thema 

Fast-Help benötigt 3 Parameter auf der Komandozeile, der erste ist der Projektname, der zweite ist ein optionaler Kompilerparameter und der dritte eine Anfrage um Fast-Help geöffnet zu lassen.


1ter Parameter: Projekt Name - Geben Sie den Totalen Pfad zu Ihrem Projekt an, z.B.:

  FastHelp.exe "C:\Test\My Projekt.mdb"


2ter Parameter: Kompiler option - Dieser zweite optionale Parameter  "-compile=" gefolgt von dem gewünschten ausgabeformat ergibt:


FastHelp.exe "C:\Test\My Projekt.mdb" -compile=HtmlHelp

FastHelp.exe "C:\Test\My Projekt.mdb" -compile=WinHelp

FastHelp.exe "C:\Test\My Projekt.mdb" -compile=RTF

FastHelp.exe "C:\Test\My Projekt.mdb" -compile=Printable

FastHelp.exe "C:\Test\My Projekt.mdb" -compile=PDF

FastHelp.exe "C:\Test\My Projekt.mdb" -compile=PocketPC

FastHelp.exe "C:\Test\My Projekt.mdb" -compile=WebSite


3ter Parameter: -StayOpen - Dieser Parameter ist optional und wenn dieser weggelassen wird, schliesst Fast-Help nach dem Kompilieren. Falls dieser gesetzt wird bleibt Fast-Help geöffnet


FastHelp.exe "C:\Test\My Projekt.mdb" -compile=HtmlHelp -StayOpen



Erweiterte Command Line Kompilierung mit ini Dateien

Bitte beachten Sie , dass diese Option nur in der Corporate Edition   verfügbar ist.

In dem Template Ordner finden Sie eine Datei mit dem Namen "Command Line Compiles.ini". Sie können diese als Basis für Ihre eigenen INI-Dateien verwenden. Z.B., wenn Sie eine Datei mit dem Namen "Acme Products.mdb" für zwei verschiedene Kunden kompilieren möchten können Sie zwei unterschiedliche INI-Dateien anlegen. Zb. "microsoft.ini" und "alleAnderen.ini". Sie können die INI-Dateien an einem beliebigen Ort abspeichern. Aber ist möglicherweise das beste, diese im gleichen Ordner wie das Projekt zu speichern.
z.B. "C:\My Projects\Acme Products 2006" Dann würde das Commandline folgendermaßen aussehen :


"C:\Program Files\FastHelp\FastHelp.exe" "C:\My Projects\Acme Products 2006\For All Others.ini"


Fast-Help wird hierauf geladen und wird dann die INI-Datei einlesen um die Kommandos darin auszuführen. Das einfachste Kommando zeigt Fast-Help an welches Projekt geladen werden soll. Folgend können Sie einen Ausschnitt aus einem INI-File sehen. der erste Teil ist die [Project] Sektion. Der Parameter "ProjectFileName" spezifiziert das Projekt welches geladen werden soll. Dies muss ein absoluter Pfad sein.

Wenn Sie nun nur dies verwenden würde Fast-Help das Projekt laden und danach wieder schliessen. Also würde in diesem Fall nicht von bedeutung passieren. Also müssen wir hier noch angeben, welches Format kompiert werden soll. Dies brindt uns zur nächsten Sektion [Compile Options] Dies beinhaltet die nächsten Befehle :

  CloseAfterCompile=Y

  FormatToCompileTo=htmlhelp

Das CloseAfterCompile=Y gibt an dass Fast-Help nach dem Kompilieren wieder geschlossen werden soll. Dies kann man mit den Optionen "Y" oder "N" steuern. Die Formatangabe gibt an in Welchem Format kompiliert werden soll. Hier gibt es folgende Optionen :

  winhelp

  htmlhelp

  website

  rtf

  pdf

  pocketpc

  wxwidgets

Hiernach sieht unser INI-File so aus :

Hiermit wird das Projekt geladen, kompiliert als HtmlHelp und wird dann geschlossen.


Mehrfaches Kompilieren

Sie können auch mehr als ein Format gleichzeitig kompilieren. Wenn Sie nun HtmlHelp und PDF in der gleichen INI datei kompilieren möchten, dann können sie mit den folgenden Optionen bis zu 7 verschiedene Vorgänge steuern :

  SecondCompile=pdf

  ThirdCompile=pocketpc

  FourthCompile=rtf

  FifthCompile=wxwidgets

  SixthCompile=website

  SeventhCompile=winhelp

Sie brauchen nur die Optionen zu spezifizieren, die Sie für das aktuelle Format benötigen. Z.B. Wenn Sie HtmlHelp und PDF erzeugen wollen, dann würden Ihre [Compile Options] folgendermassen aussehen :

  [Compile Options]

  FormatToCompileTo=htmlhelp

  SecondCompile=pdf

Jeder kompilvorgang wird in der Liste bis zum Punkt "SeventhCompile" ausgeführt



Setzen von Variablen

Lassen Sie uns annehmen, dass Sie zwei Variablen haben "Firmenname" und "Copyright". Wenn Sie nun kompilieren möchten Sie in einer bestimmten INI-Datei diese Variablen mit übergeben sodass Sie unterschiedliche Ergebnisse bekommen. Um nun diese Variablen zu setzen kommen wir zu der [Variables]

Sektion. Fügen Sie hier die Variablen ohne Klammer und führendes $ ein und weisen Sie dieser Variable mit einem = einen Wert zu. Dieser wird dann beim Kompilieren jeweils an der passenden Stelle ersetzt.

Bitte beachten Sie dass Variablen als PLAINTEXT übertragen werden un u.u. die Formatierung des Umgebenden Textes annehmen werden.


Ich bin mir Sicher, dass Sie erkennen wie nützlich dieses Feature ist. Hiermit können Sie für viele verschiedene Firmaen die gleiche Hilfedatei verwenden. Oder Personifizierte PDFs erzeugte usw.



Bedingungen setzen

Lassen Sie uns annehmen, Sie haben zwei Bedingungen "NOT YET LIVE" und "For Microsoft Only".

In der Sektion [Conditions] können Sie diese Bedingungen mit einem gleich zuweisen. Die Optionen können hier "Y" oder "N" sein um diese mit Wahr oder Falsch auszuführen.


Ausblenden von Themen und Popups

Es gibt manchmal die Herausforderung, dass Sie bestimmte Themen oder Popupseiten, die für einen bestimmten Kunden sind ausblenden möchten. Dies können Sie in der Sektion [ExcludeTopics] und [ExcludePopups] angeben. Hier müssen Sie den eindeutigen Contextstring angeben um das Thema eindeutig zu identifizieren. Wenn Sie z.B. eine Seite mit dem Titel "Welcome to Acme v1.0" haben finden Sie im Contextstring die Bezeichnung  "WelcomeToAcmeV10" und Sie möchten, dass diese Seite beim nächsten Kompilieren ausgeblendet wird und die Seite "Introduction" soll eingeblendet werden. Weiterhin möchten, dass das Popup "WhatIsAFilter" eingeblendet wird.


Übersetzungen

Es gibt zwei Optioenen, die die Übersetzungen betreffen. Dies ist die zu ladende Sprache und ob kompiliert werden soll. Diese Sektion sieht im folgenden so aus :

  [Translations]

  LanguageToLoad=Korean

  CompileTranslation=Y

In diesem Fall laden wir die Übersetzung für "Korean" und die Übersetzung wird kompiliert, da die Option auf Y gesetzt ist.


HtmlHelp Spezifische Optionen

In der INI Datei können Sie alle Optionen setzten, die Aie auch in dem interactiven Fenster setzten können. Keine dieser Optionen ist eine Pflichtoption. Diese erlauben Ihnen einfach die Anzeige im kompilerscreen zu setzen. Wenn Sie keine Änderungen setzen möchten können sie die nächste Option einfach weglassen.


Eine nützliche Option ist einen anderen Dateinamen für die Ausgabe anzugeben. In diesem Beispiel wird der Dateiname auf "Acme General" gesetzt. Bitte beachten Sie , dass die Dateierweiterung .CHM nicht mit angegeben wird. Diese wird durch Fast-Help automatisch ergänzt.


Sie können auch den Speicherort für die Kompilierte Datei mit angeben. Die option "CopyFileTo" benötigt einen absoluten Pfad zu der Ausgabestelle. Die restlichen Optionen sind in der unten stehenden Tabelle aufgeführt.



[HtmlHelp Options]

FileName

Der Name der kompilierten Datei ohne die Dateierweiterung.

IncludeNonscroll

Wenn "Y" gesetzt, dann wird der Titelbereich über dem Hilfetext mit eingefügt.

AddBrowseButtons

Wenn "Y", werden die navigationsbuttons mit in den Titelbereich eingefügt.

ConvertUnicodeToAnsi

Wenn "Y", Wird der gesamte Unicode in ANSI umgewandelt. Es werden die Einstellungen aus der lokalen Windowsumgebung übernommen.

UseInternationalCharacterSet

Wenn ConvertUnicodeToAnsi ist "Y" und diese Option ist auch "Y", dann wird statt der Windowseinstellung die Einstellung bei den HtmlHelp Kompileroptionen übernommen.

AutomaticallySortTheIndex

Dies sortiert alle Schlagworte aus dem Index-Reiter in alpabetischer Reihenfolge.

QuickCompile

Wenn "Y", werden nur diese Seiten neu Kompiliert, die seit dem letzten kompilieren verändert wurden. Dies verringert die Wartezeit beim Kompilieren. Wenn Sie hier "N" setzen werden alle Themen erneut kompiliert.

ConvertBMPsToJPGs

Auch wenn HtmlHelp normalerweise Bitmaps anzeigt, sind diese meist sehr groß. Wenn Sie diese option auf "y" setzen werden die Bilder entsprechend in JPGs gewandelt und sparen somit Platz und Ladezeit.

AutoLink

Wenn "Y", wird das  AutoLinking Feature alle Seiten automatisch nach den Autolinkworten durchsuchen und diese verknüpfen.

CopyFileTo

Kopiert die kompilierte CHM datei in einen bestimmten ordner



WinHelp Specific Options

[WinHelp Options]

FileName

Der Name der kompilierten Datei ohne die Dateierweiterung.

Compress

Wenn "Y", wird der Kompilier die Datei in einem kompimierten Format als .hlp ablegen. Dies funktioniert gut, wenn in Ihrem Projekt eine Menge Bilder abgelegt sind. Aber es kann auch sein, dass das kompilieren fehlschlägt, da der Microsoft kompiler schon etwas älter ist.

AutomaticBrowseSequence

Wenn "Y", werden die navigationsbuttons mit in den Titelbereich eingefügt.

AutomaticallySortTheIndex

Dies sortiert alle Schlagworte aus dem Index-Reiter in alpabetischer Reihenfolge.

CopyFileTo

Kopiert die kompilierte CHM datei in einen bestimmten ordner



Website Specific Options

[Website Options]

HomePageFileName

Der Dateiname der Startseit lautet normalerweise "index", ohne Dateierweiterung.

IncludeContents

Wenn "Y", wird der Inhaltsreiter inzugefügt

IncludeIndex

Wenn "Y", wird der index hinzugefügt

IncludeSearch

Wenn "Y", wird der Reiter für das Suchen hinzugefügt

FullTextSearch

Normalerweise wird die Suche auf Phrasen und Schlagworte ausgeführt, wenn Sie diese Option auf "Y" setzen wird der gesamte Inhalt durchsucht. Dies benötigt zwar mehr speicher, kann aber in einigen Fällen nützlich sein.

IncludeNonscroll

Wenn "Y" gesetzt, dann wird der Titelbereich über dem Hilfetext mit eingefügt.

AddBrowseButtons

Wenn "Y", werden die navigationsbuttons mit in den Titelbereich eingefügt.

QuickCompile

Wenn "Y", werden nur diese Seiten neu Kompiliert, die seit dem letzten kompilieren verändert wurden. Dies verringert die Wartezeit beim Kompilieren. Wenn Sie hier "N" setzen werden alle Themen erneut kompiliert.

AllowAccessToThisSiteViaSSL

Die Webseite hat normalerweise eine Referenz auf "about:blank", diese wird aber von SSL Zertifikaten bemängelt. Wenn dies auf "Y" gesetzt ist, dann wird dies übersprungen.

EnableAppleMacBrowserSupport

Der Safari browser arbeitet nicht mit unicode JavaScript, wenn diese Option ausgewählt ist, dann wird der JavaScript Part in ANSI gespeichert.


AutoLink

Wenn "Y", wird das AutoLinking Feature alle Seiten automatisch nach den Autolinkworten durchsuchen und diese verknüpfen.

UseFlyoverPopups

Wenn "Y", Flyover Popups werden verwendet



RTF Specific Options

[RTF Options]

FileName

Der Name der kompilierten Datei ohne die Dateierweiterung.

HeadingsStartOnNewPage

Wenn "Y", wird jeder Titel auf einer neuen Seite begonnen

TopicsStartOnNewPage

Wenn "Y", wird jedes Thema auf einer neuen Seite begonnen

FirstTopicAfterHeadingStartsOnNewPage

Dies steht normalerweise auf "N" , sodass ein Thema unmittelbar auf einen Titel auf der gleichen Seite folgt. Wenn dies auf "Y" gesetzt wird wird das erste Thema auf einer neuen Seite anch dem Titel erfolgen.

IncludePageNumbersInHeader

Wenn diese und die nächste Option auf "Y" gesetzt werden können die Seitenzahlen oben oder unten eingeblendet werden.

IncludePageNumbersInFooter

Wenn "Y" wird die Seitenzahl im Footer eingeblendet

OptimizeCompileTime

Wenn "N", werden nur die geänderten Seiten erneut kompiliert und Wenn "Y" dann werden alle Seiten erneut kompiliert.

PrintEditableHeadings

Normalerweise enthalten die Titelbereiche das gleiche wie der Titel sebst und keinen relevanten Hilfetext. Mit dieser Option könnte man diese Bereiche zusätzlich einblenden.

ConvertBMPsToJPGs

Bitmaps sind in der Regel größer und können mit dieser Option in JPGs gewandelt werden. Hierdurch wird das Dokument viel kleiner.

ConvertAnyPNGImagesToJPG

MS Word kann nicht richtig mit PNG Bildern umgehen, daher empfiehlt sich PNG Dateien in JPGs zu konvertieren indem man diese Option auf "Y" setzt.

StoreImagesExternally

Wenn "Y", dann werden alle Bilder durch einen externen Link referenziert und nicht in das Dokument eingebettet. Somit kann ein sehr kleines File erzeugt werden. Wenn Sie lokal arbeiten stellt dies kein Problem dar. Wenn Sie diese Datei weitergeben möchten sollten Sie diese Option auf "N" stellen.

SaveStyleNames

Wenn "Y", dann werden die Style Namen in das RTF exportiert sodass diese von dem RFT File interpretiert werden können.



PDF Specific Options

[PDF Options]

FileName

Der Dateiname ohne Dateierweiterung.

Title

Der Titel des PDF Dokumnetes

Compress

Die Kompression in PDF Files ist nicht wirklich gut, kann aber zur verkleinerung der Dateigröße beitragen. Wenn Sie diese Option auf "Y" setzten kann dies Auswirkungen auf die Größe haben.

OptimizeCompileTime

Wenn "N", dann werden werden nur die geänderten Themen verarbeitet, dies kann die Wartezeit beim Kompilieren verkürzen.. Wenn "Y" werden alle Seiten verarbeitet.

PrintEditableHeadings

Normalerweise, werden die Titel nicht nochmals in einem PDF File angeziegt. Da diese aber editiert werden können kann man mit dieser Option diese Titel in das PDF einbinden.

UseLinks

Wenn "Y", dann werden Themenlinks zu internen Links innerhalb des PDFs gewandelt. Dies hilft Ihnen dabei in Ihrem PDF zu navigieren, ähnlich wie bei einem HTML-Dokument



PocketPC Specific Options

[PocketPC Options]

FileName

Der Dateiname ohne Dateierweiterung.

Title

Der Titel des Dokumentes

Compress

Die Kompression in PDF Files ist nicht wirklich gut, kann aber zur verkleinerung der Dateigröße beitragen. Wenn Sie diese Option auf "Y" setzten kann dies Auswirkungen auf die Größe haben.

OptimizeCompileTime

Wenn "N", dann werden werden nur die geänderten Themen verarbeitet, dies kann die Wartezeit beim Kompilieren verkürzen.. Wenn "Y" werden alle Seiten verarbeitet.

PrintEditableHeadings

Normalerweise, werden die Titel nicht nochmals in einem PDF File angeziegt. Da diese aber editiert werden können kann man mit dieser Option diese Titel in das PDF einbinden.

UseLinks

Wenn "Y", dann werden Themenlinks zu internen Links innerhalb des PDFs gewandelt. Dies hilft Ihnen dabei in Ihrem PDF zu navigieren, ähnlich wie bei einem HTML-Dokument



wxWidgets Specific Options

[wxWidgets Options]

FileName

Der Dateiname der  wxWidgets Datei ohne Dateierweiterung

All Other Options

Alle anderen HtmlHelp Optionen - siehe oben für mehr Infromationen.



Auskommentieren

Wenn Sie Notizen hinzufügen wollen können Sie innerhalb des INI-Files durch ein vorangestelltes Semikolon eine Zeile Auskommentieren um Ihre eigenen Notizen dort zu hinterlegen. Hiermit wird diese Zeile im INI File einfach ignoriert. Damit könnten verschiedene Variablen auskommentiert werden ohne diese zu löschen

  [Variables]

  PhoneNumber=555-123-456

Somit könnte diese Variable z.B. auskommentiert werden um diese später nochmals zu wen.

  [Variables]

  ;PhoneNumber=555-123-456

  PhoneNumber=272-938-010