Longhorn Help Inhalte verfassen - Erste Schritte mit dem Longhorn Build 4051

Dieser Artikel führt durch alle notwendigen Arbeiten, um eine .HELP Datei zu erstellen und diese auf einem Computer anzuzeigen der Microsoft Windows [Version 6.0.4051] Codename "Longhorn" installiert hat. Wenn Sie diese Freigabe installiert haben, ist auch gleichzeitig das erforderliche .NET Framework 1.2.3070 installiert.

Hinweis: Inzwischen liegt die Freigabe der Alpha Version 4074 vor. Informationen unterliegen im Moment noch sehr starken Änderungen.

© 2003 Microsoft Corporation. Alle Rechte vorbehalten.
Microsoft, sind entweder eingetragene Warenzeichen oder Warenzeichen der Microsoft Corporation in den Vereinigten Staaten und/oder anderen Ländern.

Erforderliche Basisinstallationen und Programme

Installation Microsoft Windows [Version 6.0.4051] "Longhorn"
Download und Installation des Longhorn HelpCompiler
[optional]: Download und Installation einer Benutzeroberfläche (jetzt: xHelpMarkup)

Hinweis: Alternative Möglichkeit für das kompileren an der Kommandozeile

Mit der Longhorn Help Compiler GUI erhalten Sie eine graphische Benutzeroberfläche, mit der das Kompilieren und Dekompilieren einer *.HELP Datei erleichtert wird. (jetzt: xHelpMarkup)

Erforderliche Dateien

In einem ersten Schritt wollen wir uns die erforderlichen Dateien in einem Diagramm (© Microsoft) und einer Tabelle ansehen.

Dateierweiterung	Verwendungszweck	HTML Help Equivalent
.help	Help Datei	.chm
.packinglist	Packlistendatei (Projektdatei)	.hhp
.taskimp	Task Implementation Datei	-
.helpmd	Help Metadaten Datei	-
.xml	Themendateien	.htm
HelpCompiler.exe	Help Compiler	hhc.exe

Die Tabell zeigt die im Prozess der Hilfeerstellung verwendeten Dateien. Der Kompilierungsprozess ist früheren Prozessen zum Anlegen von Hilfedateien sehr ähnlich. Ein wesentlicher Unterschied zu HTMLHelp (CHM) besteht darin, das die erzeugte Hilfedatei (*.help) kompiliert aber nicht komprimiert wird.

Hilfeinhalte verfassen

Als erster Arbeitsschritt sind die anzuzeigenden Hilfethemen zu erstellen. Dieser Inhalt wird mit Hilfe der Microsoft Hilfemarkierungssprache (MAML) verfasst. Große Änderungen liegen in der technischen Dokumentation von Programmen vor uns. Rob Chandler ( www.helpwaregroup.com ) erwähnt es in seinem Papier "UI & UA Änderungen auf dem Weg zu Longhorn": Technische Autoren müssen ihre Arbeitsweise ändern". Sein Papier gibt einen Einblick, was im Benutzerschnittstellenteil (UI) und beim Design der Benutzerhilfe (UA) geschieht, während der Weg zu Longhorn begangen wird. Hier sind wesentliche Informationen für alle Entwickler enthalten.

Hilfethemen erstellen
Beachten Sie vor dem Start den Hinweis: Alternativmöglichkeit für das Kompilieren

1. Erstellen Sie ein Verzeichnis, um Ihre Projektdateien zu speichern.
2. Starten Sie den XML- oder Texteditor Ihrer Wahl.
3. Erstellen Sie ein neues leeres Dokument und fügen Sie folgenden Inhalt ein:

<?xml version="1.0" encoding="UTF-8"?>
<conceptual xmlns="http://schemas.microsoft.com/maml/2003/5"
 xmlns:doc="http://schemas.microsoft.com/maml/internal"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://schemas.microsoft.com/maml/2003/5
C:\Program Files\Microsoft Longhorn SDK\misc\MAML_Schema\Maml.xsd"
 xmlns:xlink="http://www.w3.org/1999/xlink">
  <title> Longhorn Help Demo: Topic 1</title>
  <content>
    <para>This is the introductory topic of the "Longhorn" Help authoring demo.</para>
    <para>This demo is edited by Help Information (c) Ulrich Kulle</para>
  </content>
  <sections>
    <section>
      <title>Link demonstration</title>
      <content>
        <para>Here is a link to <link xlink:href="help://microsoft.windows/default.aspx?language=en-us&amp;
              version=6.0.0.1&amp;bundleid=LonghornHelpDemo&amp;topic=/Topic2.xml">Topic 2</link>.
        </para>
      </content>
    </section>
  </sections>
</conceptual>

4. Speichern Sie das Dokument als Topic1.xml in dem Ordner, den Sie in Schritt 1 erstellt haben.
5. Wiederholen Sie die Schritte 2 und 3 mit dem folgenden Inhalt und speichern Sie als Topic2.xml:

<?xml version="1.0" encoding="UTF-8"?>
<conceptual xmlns="http://schemas.microsoft.com/maml/2003/5"
  xmlns:doc="http://schemas.microsoft.com/maml/internal" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://schemas.microsoft.com/maml/2003/5
  C:\Program Files\Microsoft Longhorn SDK\misc\MAML_Schema\Maml.xsd"
  xmlns:xlink="http://www.w3.org/1999/xlink">
  <title> Longhorn Help Demo: Topic 2</title>
   <content>
    <para>This is the second topic of the "Longhorn" Help authoring demo.</para>
   </content>
   <sections>
   <section>
    <title>Link demonstration</title>
     <content>
      <para>Here is a link back to <link xlink:href="help://microsoft.windows/default.aspx
      ?language=en-us&amp;version=6.0.0.1&amp;bundleid=LonghornHelpDemo&amp;topic=/Topic1.xml">
      Topic 1</link>.</para>
     </content>
   </section>
   </sections>
</conceptual>

Projektdateien

Es werden zwei Projektdateien benötigt, um eine .HELP Datei zu erstellen: die Packlisten- und die Metadatendatei. Die Packlistendatei (.packinglist) ist eine Liste aller Dateien, die in eine .HELP Datei einzubeziehen sind. Es ist die einzige Datei, die dem Compiler übermittelt wird. Die Metadaten der Hilfedatei (.helpmd) definieren die virtuelle Dateistruktur und URIs für eine.HELP Datei und identifizieren, welche Dateien vom Promotion Manager zur Laufzeit angesprochen werden.

Weil jedes Hilfethema mit einer Aufgabe verbunden werden muss, sind zwei zusätzliche Dateien erforderlich: die Aufgabenimplementierungsdatei und die Aufgabendefinitionsdatei. Dies dient dazu eine neue Aufgabenkategorie zu definieren die "Help System" heißt und das Einführungsthema mit seiner Aufgabe zu verbinden.

Hinweis: Die Dateiformate für die Aufgabendeklaration werden schon in der nächsten Freigabe (6.0.4074) völlig umgestaltet. Es ist einzig beabsichtigt, in diesem beispielhaften Durchgang die gewünschte Funktionalität für eine Demonstration zu liefern.

Erstellen Sie ein neues Dokument und fügen Sie den folgenden Inhalt ein:

<?xml version="1.0" encoding="utf-8"?>
  <packingList copyright="Microsoft Corporation 2003" langId="1033" fileVersion="1.0.0.0">
  <entry url="LonghornHelpDemo.helpmd" />
  <entry url="LonghornHelpDemo.taskimp" />
  <entry url="LonghornHelpDemo.taskdef" />
  <entry url="Topic1.xml" />
  <entry url="Topic2.xml" />
  </packingList>

Sichern Sie die Datei als LonghornHelpDemo.packinglist in Ihrem Projektordner.

Um die Hilfemetadaten zu erstellen:
1.Starten Sie den XML- oder Texteditor Ihrer Auswahl.
2. Erstellen Sie ein neues Dokument und fügen Sie den folgenden Inhalt ein:

<helpMetadata xmlns="urn:schema.setup.microsoft.windows.com">
<helpFileIdentity name="LonghornHelpDemo" publicKeyToken="1111222233334444" version="1.0.0.0">
</helpFileIdentity>
<description>
  <product name="microsoft.windows" serverUrl="www.help.microsoft.com" version="6.0.0.1">
    <bundle name="LonghornHelpDemo" language="en-us" description="Longhorn Help Authoring Demo">
    </bundle>
  </product>
</description>
<topics>
  <topic title="Longhorn Help Demo: Topic 1" subUrl="/Topic1.xml" url="help://microsoft.windows/
     default.aspx?language=en-us&amp;version=6.0.0.1&amp;bundleid=LonghornHelpDemo&amp;topic=/Topic1.xml">
  </topic>
  <topic title="Longhorn Help Demo: Topic 2" subUrl="/Topic2.xml" url="help://microsoft.windows/
     default.aspx?language=en-us&amp;version=6.0.0.1&amp;bundleid=LonghornHelpDemo&amp;topic=/Topic2.xml">
  </topic>
</topics>
</helpMetadata>

Erstellen Sie die Aufgabenimplementierungsdatei (.taskimp)
1. Starten Sie den XML- oder Texteditor Ihrer Wahlahl.
2. Erstellen Sie ein neues Dokument und fügen Sie den folgenden Inhalt ein:

<?xml version="1.0" encoding="utf-8"?>
<assembly xsi:schemaLocation="urn:schema.setup.microsoft.windows.com Component.0.0.0.5.xsd"
  manifestVersion="1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns="urn:schema.setup.microsoft.windows.com">
  <assemblyIdentity name="LonghornHelpDemo" publicKeyToken="1111222233334444" version="1.0.0.0" />
  <description>
    <DisplayName>Longhorn Help Demo</DisplayName>
    <OwnerType>Windows</OwnerType>
  </description>
  <memberships>
    <categoryMembership name="Microsoft.Windows.Shell.Tasks"
        publicKeyToken="5555666677778888" version="1.0.0.0">
      <task name="Longhorn_Help_Demo.0001">
        <entryPoint name="LHD_entrypoint.0001" />
      </task>
    </categoryMembership>
  </memberships>
  <entryPoints>
    <taskProviderEntryPoint name="LHD_entrypoint.0001"
       clsid="C69A61FF-9CEA-42C3-9651-D2B014A84CE9"
       data="help://microsoft.windows/default.aspx?language=en-us&amp;version=6.0.0.1
       &amp;bundleid=LonghornHelpDemo&amp;topic=/Topic1.xml">
    </taskProviderEntryPoint>
  </entryPoints>
</assembly>

3. Sichern Sie die Datei als LonghornHelpDemo.taskimp in Ihrem Projektordner.

Erstellen Sie die Aufgabendefinitionsdatei (.taskdef)
1. Starten Sie den XML- oder Texteditor Ihrer Wahl.
2. Erstellen Sie ein neues Dokument und fügen Sie den folgenden Inhalt ein:

<?xml version="1.0" encoding="UTF-16"?>
  <assembly manifestVersion="1.0" xmlns="urn:schema.setup.microsoft.windows.com">
  <assemblyIdentity name="LonghornHelpDemo" publicKeyToken="1111222233334444"
  version="1.0.0.0">
  </assemblyIdentity>
  <description>
  <DisplayName>Longhorn Help Demo</DisplayName>
  <OwnerType>Windows</OwnerType>
  </description>
  <memberships>
  
  <!--Task Declarations-->
  <categoryMembership name="Microsoft.Windows.Shell.Tasks"
  publicKeyToken="5555666677778888" version="1.0.0.0">
  <task name="Longhorn_Help_Demo.0001"
  UID="635106e5-d089-4b6b-b2c5-52d11b2b89f5"
  displayName="Longhorn Help Demo (task)"
  displayNameSingleSelect=""
  displayNameFolderSelect=""
  displayNameMultiSelect=""
  toolTip=""
  icon=""
  isPinnable="False"
  isAppSpecific="False">
  </task>
  </categoryMembership>
  <categoryMembership subcategory="Microsoft.Windows.Shell"
  name="Microsoft.Help.Collection"
  publicKeyToken="5555666677778888" version="1.0.0.0">
  <CollectionMember taskName="Longhorn_Help_Demo.0001">
  </CollectionMember>
  </categoryMembership>
  <categoryDefinition name="Microsoft.Windows.Shell.CatalogCategory"
  version="1.0.0.0" publicKeyToken="5555666677778888"
  subcategory="97c98cb3-9333-42a5-8601-242d518834af">
  <CatalogCategory displayName="Help System">
  </CatalogCategory>
  </categoryDefinition>
 <categoryMembership name="Microsoft.Windows.Shell.CatalogCategory"
  version="1.0.0.0" subcategory="97c98cb3-9333-42a5-8601-242d518834af"
  publicKeyToken="A??i?_???_???_?5555666677778888">
  <CategoryMember taskName="Longhorn_Help_Demo.0001">
  </CategoryMember>
  </categoryMembership>
  
  <!--Assign SubjectTerms to the Tasks-->
  <categoryMembership name="Microsoft.Windows.Shell.SubjectTerm"
  version="1.0.0.0" publicKeyToken="5555666677778888" subcategory="Help System" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SubjectTermMember taskName="Longhorn_Help_Demo.0001" />
  </categoryMembership>
  </memberships>

3. Speichern Sie die Datei als LonghornHelpDemo.taskdef in Ihrem Projektordner. Wichtig: Die Datei .taskdef muss mit Unicode Verschlüsselung gespeichert werden.

Das Kompilieren der Datei .HELP

Jetzt sind Sie soweit, die .HELP Datei zu kompilieren. Bedenken Sie, dass der Compiler (Helpcompiler.exe), der mit diesen Unterlagen mitgeliefert wird, nur mit dem Windows "Longhorn" Betriebssystem für die Freigabe 4051 kompatibel ist.

Die Datei .HELP kompilieren
1. Öffnen Sie das Kommandozeilenfenster (Eingabeaufforderung) z.B. über "Start | Ausführen".
2. Navigieren Sie zu dem lokalen Verzeichnis, in dem sich der Helpcompiler.exe befindet.
3. Verwenden Sie bitte folgende Syntax an der Eingabeaufforderung, um den Compiler zu starten. Tauschen Sie vorher den Pfad für die Packlistendatei Ihres Projektes.

helpcompiler -p c:\myProject\LonghornHelpDemo.packinglist

4. Wenn die Verarbeitung abgeschlossen ist, wird Ihrem Projektordner eine Datei mit dem Namen LonghornHelpDemo.help hinzugefügt.

Hinweis: Alternative Möglichkeit für das kompileren an der Kommandozeile

Mit der Longhorn Help Compiler GUI können Sie eine graphische Benutzeroberfläche benutzen, mit der das Kompilieren und Dekompilieren einer *.HELP Datei erleichtert wird (jetzt: xHelpMarkup)

Das Installieren der .HELP Datei

Verwenden Sie das Hilfeinstallations- und das Indexierungshilfsprogramm, um Ihre .HELP Datei ins Windows Dateisystem zu installieren.

Das Hilfeinstallations- und Indexierungshilfsprogramm ausführen

1. Kopieren Sie LonghornHelpDemo.help in C:\Windows\Help.
2. Klicken Sie die Taskleiste mit der rechten Maustaste und wählen Sie den Taskmanager.
3. Öffnen Sie zuätzlich die Eingabeaufforderung (DOS-Fenster).
4. Navigieren Sie zu C:\Windows\System32.
5. Geben Sie "nuimpmpx" (ohne die Anführungszeichen) ein und drücken Sie dann die Eingabetaste.
6. Stellen Sie durch Überprüfung im Taskmanager sicher, dass der Prozess nuimpmpx fertig geworden ist (er erscheint dann nicht mehr im Taskmanager Fenster).

Der Registrierungsprozess sucht bei Beginn alle auf dem System vorhandenen *.help Dateien und registriert diese. Der Vorgang benötigt einige Zeit. Der Prozess beansprucht sehr viel Ressourcen und läuft auf einem Pentium 4 mit 512 MB Arbeitsspeicher und 1,8 GHz einige Minuten.

Sie können die folgende Prozedur zur Einsicht der Installationsprotokolldatei verwenden.

Um das Promotion Managerprotokoll einzusehen

1. Öffnen Sie die Eingabeauffordrung (DOS-Fenster).
2. Geben Sie "cd %temp%" (ohne die Anführungszeichen) ein und drücken Sie dann Enter.
3. Geben Sie "cd HelpTraceLogs" (ohne die Anführungszeichen) ein und drücken Sie dann Enter.
4. Geben Sie "notepad promotionmanager.txt" ein und drücken Sie dann Enter.

Die .HELP Datei ansehen

Um das Hilfefenster zu starten und die Longhorn Help Demo zu sehen

1. Klicken Sie Start, dann "Ausführen", geben Sie "helppane" (ohne die Anführungszeichen) ein und drücken Sie Eingabe.
2. Am oberen Ende des Hilfefensters klicken Sie Optionen und wählen Sie "View all Tasks" aus.
3. In der Aufgabenliste suchen die durch Scrollen die Kategorie "Help System" und Doppelklicken Sie "Longhorn Help Demo", um das Einführungsthema anzuzeigen. Sie können auch eine Suche nach "Longhorn Help Demo" durchführen.