Share via


Provide help text, hyperlinks, or web content on a work item form

Wenn Sie das Arbeitsaufgabenformular anpassen, sollten Sie Informationen oder Links zu Inhalten, mit denen das Team die Felder im Formular definieren kann, zur Verfügung zu stellen. Wenn Sie Informationen in das Formular einbetten oder den Zugriff darauf erleichtern, können Teammitglieder besser nützliche Daten verfolgen.

Wenn Sie die Steuerelemente des Formulars verwenden, die in diesem Thema beschrieben werden, können Sie QuickInfo-Text für einzelne Felder, eigenständigen Text oder Hyperlinks zu Webseiten hinzufügen oder HTML- bzw. Webinhalte in das Formular einbetten.

Sie ändern das Arbeitsaufgabenformular, indem Sie die Definition für den Arbeitsaufgabentyp ändern. Sie können das witadmin Befehlszeilentool verwenden. Informationen finden Sie unter Importieren, Exportieren und Verwalten von Arbeitsaufgabentypen [witadmin], oder dem Prozess-Editor.

Der Prozess-Editor ist ein leistungsstarkes Tool-Add-In für Visual Studio, das Sie herunterladen und installieren können. Der Prozess-Editor befindet sich im Menü "Extras" und bietet eine grafische Benutzeroberfläche, um Objekte zum Nachverfolgen von Arbeitsaufgaben in Team Foundation Server anzupassen. Sie können dieses Tool verwenden, um Arbeitsaufgabentypen zu importieren und zu exportieren und ihre Definitionen zu ändern. Weitere Informationen finden Sie auf der folgenden Seite der Microsoft-Website: Team Foundation Server Power Tools.

Bereitstellen von Hilfetext oder QuickInfo-Text

Sie können Hilfetext auf zwei Arten bereitstellen. Bei der ersten Methode fügen Sie das HELPTEXT-Element dem FIELD-Element als untergeordnetes Element im Abschnitt FIELDS der Typdefinition hinzu. Mithilfe von HELPTEXT erstellen Sie die QuickInfo für das Feld. Bei dieser Methode haben Sie maximal 255 Zeichen zur Verfügung.

<FIELD name="Sub-Title" refname="ACME.ACE.ImpactStatement" type="HTML" >
<HELPTEXT>Provide information about the impact to the ACE organization. </HELPTEXT>
</FIELD>

Bei der zweiten Methode geben Sie eigenständigen Text mithilfe der untergeordneten Elemente LabelText und Text ein. Bei dieser Methode können Sie so viele Informationen wie Sie möchten hinzufügen, und der Text wird dauerhaft auf dem Formular angezeigt. Es ist keine Benutzeraktion erforderlich. Sie können auch einen optionalen Link zu weiteren Informationen mit dem Link-Element hinzufügen, wie im folgenden Beispiel gezeigt.

<Control FieldName=" ACME.ACE.ImpactStatement" Type="HTMLControl" Label="Impact" LabelPosition="Left"> 
   <LabelText>
      <Text>Provide information about the impact to the ACE organization. Specifically address the following: customer segment, target strategic opportunity, resources required, and time dependencies. For more detailed information, see the Impact Statement specification at:
         <Link OpenInNewWindow="true" UrlRoot=http://ACE.ImpactStatement.aspx />
      </Text>
   </LabelText>
</Control>

Sie können einem Arbeitsaufgabenformular Text hinzufügen, der keinem Arbeitsaufgabenfeld zugeordnet ist. Verwenden Sie dazu die Type-Attributsoption LabelControl des Control-Elements. Der Text kann das Nur-Text- oder Hyperlinkformat besitzen. Sie können an eine hinzugefügte Feldbezeichnung mithilfe der Option FieldControl auch einen Hyperlink anfügen.

Beispiel: Nur-Text-Bezeichnung

Das folgende Beispiel fügt den Nur-Text "Fill in the details of the bug here. Fields that are not required are recommended to be filled in." dem Arbeitsaufgabenfeld hinzu.

<Control Type="LabelControl" Label="Fill in the details of the bug here. Fields that are not required are recommended to be filled in." />

Beispiel: Hyperlinkfeldbezeichnung

Das folgende Beispiel veranschaulicht, wie Sie einer Feldbezeichnung einen Hyperlink hinzufügen.

<Control Type="FieldControl" FieldName="System.Title" LabelPosition="Left" Label="Title 1"
   <LabelText>
      <Text>
         <Link UrlRoot="http://www.live.com/" />
            Title 2
      </Text>
   </LabelText>
</Control>

Hinweis

Bei Team Foundation-Clients, die nicht auf die neueste Version aktualisiert wurden, wird der Label-Attributtext angezeigt.Bei Visual Studio 2012 Clients wird das Text-Tag als Hyperlink angezeigt, bei dem die URL mit dem Link-Tag definiert wird.

Das folgende Beispiel zeigt, wie Sie einem Teil einer Feldbezeichnung einen Hyperlink hinzufügen. In diesem Beispiel wird die URL durch die Werte bestimmt, die den Param-Elementen zugewiesen werden, basierend auf der bestimmten Arbeitsaufgabe.

<Control Type="FieldControl" FieldName="System.IterationPath">
   <LabelText LabelPosition="Left">
      <Text>
         <Link UrlRoot="@ProcessGuidance" UrlPath="{0}.html">
            <Param Index="0" vValue"System.WorkItemType"/>         </Link>
            Iteration Path
      </Text>
      <Text> (must be 3 levels deep)</Text>
   </LabelText>
</Control>

Beispiel: Hyperlinktext-Bezeichnung

Hyperlinktext-Bezeichnung

Beispiel für einen auf eine eigenständige Bezeichnung angewendeten Link

Das folgende Beispiel veranschaulicht, wie Sie angezeigtem Text in einem Arbeitsaufgabenformular einen Hyperlink hinzufügen.

<Group>
   <Column PercentWidth="100">
      <!-- Standalone label control 2 -->
      <Control Type="LabelControl" Label="How do I use this work item?">
         <Link UrlRoot="http://www.live.com"></Link>
      </Control>
   </Column>
</Group>

Kombinieren von Text und Hyperlinks in einer einzelnen Beschriftung

Beispiel für zwei auf einen Text angewendete Links

Das folgende Beispiel zeigt, wie Sie Teilen einer Bezeichnung in einem Arbeitsaufgabenformular zwei Hyperlinks hinzufügen.

<Group>
   <Column PercentWidth="100">
   <!-- Standalone label control 3 -->
      <Control Type="LabelControl" Name="Microsoft.VSTS.Common.GuidanceLabel3">
         <LabelText>
            <Text>Click here for </Text>
            <Text>
               <Link UrlRoot="https://www.msn.com"></Link>
               work item guidance</Text>
            <Text> or here for </Text>
            <Text>
               <Link UrlRoot="http://www.msdn.com"></Link>
               process guidance
            </Text>
         </LabelText>
      </Control>
   </Column>
</Group>

Das folgende Beispiel zeigt, wie Sie einer Feldbezeichnung, die anhand von für die offene Arbeitsaufgabe ausgewerteten Parameterwerten generiert wurde, einen Hyperlink hinzufügen.

<Control Type="FieldControl" FieldName="System.State" Label="&amp;State:" LabelPosition="Left">
   <Link OpenInNewWindow="true" UrlRoot="http://" UrlPath="myserver.com:8080/tfs/myproject/{0}/_workItems#_a=edit&id=">      <Param Index="0" Value="System.State" Type ="Original"/>
   </Link>
</Control>

Anzeigen von Webinhalten

Sie können die Type-Attributoption WebpageControl verwenden, um Webinhalte im Arbeitsaufgabenformular als Steuerelement anzeigen, anstatt eine Verknüpfung zu einer separaten Webseite herzustellen. Diese Anzeige kann für die Bereitstellung von Metriken nützlich sein, die Teammitglieder bei der Anzeige von Inhalten eines Berichts, Dashboards oder von anderem HTML-basierten Inhalt unterstützen. Sie können einen Link zum Inhalt bereitstellen oder unformatierten HTML-Inhalt in einem CDATA-Tag einbetten.

Beispiel: Anzeigen von mit einer URI bereitgestelltem Inhalt

Das folgende Beispiel zeigt, wie Sie den Inhalt aus einer Webseite einbetten können, indem Sie die URL der Seite mithilfe der WebpageControlOptions- und Link-Elemente bereitstellen.

<Tab Label="Web">
   <Group>
      <Column PercentWidth="100">
         <Control Type="WebpageControl" Name="WssPortalPage" Label="WssPortalPage" LabelPosition="Top" >
            < WebpageControlOptions AllowScript="true">
               <Link UrlRoot="http://www.msdn.com" />
            </WebpageControlOptions >
         </Control>
      </Column>
   </Group>
</Tab>

Beispiel: Anzeigen von in einem CDATA-Tag bereitgestelltem Inhalt

Das folgende Beispiel zeigt, wie Sie HTML-Inhalt einem Arbeitsaufgabenformular hinzufügen können, das in einem CDATA-Tag enthalten ist.

<Control Type="WebpageControl">
   <WebpageControlOptions>
      <Content>
      <![CDATA[Place HTML Formatted Content Here ]]
   </Content>
   </WebpageControlOptions >
</Control>

Einbetten von Prozessleitfaden

Um Prozessleitfaden im Arbeitsaufgabenformular verfügbar zu machen, empfiehlt es sich, eine Registerkarte hinzufügen, die Informationen zum Workflow und zur Verwendung des Arbeitsaufgabentyps enthält. Verwenden Sie dazu die Type-Attributsoption WebpageControl. Diese Option bietet Unterstützung für das Einbetten von Rich-formatiertem Text und Bildern in das Formular mithilfe der untergeordneten Elemente WebpageControlOptions und Content.

<FORM>
. . .
<TabGroup>
. . . 
   <Tab Label="Process Guidance">
      <Group>
         <Column PercentWidth="100">
            <Control Type="WebpageControl">
            <WebpageControlOptions >
            <Content>
               <![CDATA[Place HTML Formatted Process Guidance Content Here ]]>
            </Content>
            </WebpageControlOptions>
            </Control>
         </Column>
      </Group>
   </Tab>
. . .
</TabGroup>
. . .
</FORM>

Siehe auch

Konzepte

Design the work item form

Anpassen der Objekte für die Arbeitsnachverfolgung als Unterstützung der Prozesse des Teams