Syntax-Leitfaden für die Markdownverwendung in Wiki

Inhaltsverzeichnis für Wiki-Seiten

Um ein Inhaltsverzeichnis zu erstellen, fügen Sie ein [[_TOC_]] hinzu. Der Toc wird generiert, wenn das Tag hinzugefügt wird und mindestens eine Überschrift auf der Seite vorhanden ist.

[[_TOC_]] kann an einer beliebigen Stelle auf der Seite platziert werden, um das Inhaltsverzeichnis zu rendern. Nur Markdownüberschriften werden für TOC berücksichtigt (HTML-Überschriftstags werden nicht berücksichtigt).

Alle HTML- und Markdowntags werden aus den Überschriften entfernt, während sie innerhalb des TOC-Blocks hinzugefügt werden. Sehen Sie sich das folgende Beispiel an, wie der Toc gerendert wird, wenn Sie einer Überschrift fett und kursiv hinzufügen.

Konsistenz wird in der Formatierung in TOC beibehalten.

Hinzufügen von Mermaid-Diagrammen zu einer Wiki-Seite

Wiki unterstützt die folgenden Mermaid-Diagrammtypen:

• Sequenzdiagramme
• Gantt-Diagramme
• Flussdiagramme

Verwenden Sie die folgende Syntax, um einer Wiki-Seite Mermaid-Diagramme hinzuzufügen:

::: mermaid
<mermaid diagram syntax>
:::

Es gibt auch eine Symbolleistenschaltfläche, um einer Wiki-Seite ein Mermaid-Standarddiagramm hinzuzufügen.

Einbetten von Videos in eine Wiki-Seite

Verwenden Sie die folgende Syntax, um Videos von YouTube und Microsoft Streams in eine Wiki-Seite einzubetten:

::: video
<iframe width="560" height="315" src="https://www.youtube.com/embed/OtqFyBA6Dbk" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
:::

Der iframe ist der iframe-Einbettungsblock des YouTube- oder Microsoft Streams-Videos.

Ergebnis:

(Das Ende ":::" ist erforderlich, um einen Seitenbruch zu verhindern.)

YAML-Tags

Jede Datei, die einen YAML-Block in einem Wiki enthält, wird von einer Tabelle mit einem Kopf und einer Zeile verarbeitet. Der YAML-Block muss der erste Punkt in der Datei sein und die Form eines gültigen YAML-Satzes zwischen drei gestrichelten Zeilen annehmen. Sie unterstützt alle grundlegenden Datentypen, Listen und Objekte als Werte. Die Syntax wird im Wiki, Codedateivorschau, unterstützt.

Einfaches Beispiel:

---
tag: post
title: Hello world
---

Tags mit Liste:

---
tags:
- post
- code
- web
title: Hello world
---

Einbetten Azure Boards Abfrageergebnisse im Wiki

Verwenden Sie die folgende Syntax, um Azure Boards Abfrageergebnisse in eine Wiki-Seite als Tabelle einzubetten:

::: query-table <queryid>
:::

Beispiel:

::: query-table 6ff7777e-8ca5-4f04-a7f6-9e63737dddf7 :::

Sie können auch die Symbolleiste und die Abfrageauswahl verwenden, um die Abfrageergebnisse in eine Wiki-Seite einzubetten.

Weitere Informationen zum Kopieren der Abfrage-URL, die eine GUID für die Abfrage bereitstellt, finden Sie unter E-Mail-Abfrageelemente oder Freigabeabfrage-URL.

@mention Von Benutzern und Gruppen

Um Benutzer oder Gruppen im Wiki zu @mention, geben Sie "@" im Wiki-Editor ein. Mit diesem @mention wird die AutomatischeUggeste geöffnet, in der Sie Benutzer oder Gruppen erwähnen können, um per E-Mail benachrichtigt zu werden.

Sie können auch auf der Bearbeitungssymbolleiste "@mention" auswählen.

Wenn Sie Seiten direkt im Code bearbeiten, verwenden Sie das folgende Muster: @<{identity-guid}> .

Seitenbesuche für Wiki-Seiten

Automatisch wird auf jeder Seite eine aggregierte Anzahl von Seitenbesuchen für die letzten 30 Tage angezeigt.

Verwenden Sie die Batch-API, pagesBatch um die tägliche Anzahl von Besuchen auf allen Seiten paginiert anzuzeigen. Sie sind jedoch nicht nach anzahl von Besuchen sortiert. Für Daten, die über 30 Tage alt sind, können Sie alle Seitenaufrufe mithilfe der REST-API abrufen. Sortieren Sie diese Seiten basierend auf der Anzahl von Besuchen, um die ersten 100 zu erhalten. Sie können diese Besuchen in einem Dashboard oder in einer Datenbank speichern.

Geben Sie das Nummernzeichen ( # ) und dann eine Arbeitselement-ID ein.

Beispiel: Eingebettetes Video

<video src="path of the video file" width=400 controls>
</video>

<video src="https://sec.ch9.ms/ch9/7247/7c8ddc1a-348b-4ba9-ab61-51fded6e7247/vstswiki_high.mp4" width=400 controls>
</video>

Beispiel: Rich-Text-Format

<p>This text needs to <del>strikethrough</del> <ins>since it is redundant</ins>!</p>
<p><tt>This text is teletype text.</tt></p>
<font color="blue">Colored text</font>
<center>This text is center-aligned.</center>
<p>This text contains <sup>superscript</sup> text.</p>
<p>This text contains <sub>subscript</sub> text.</p>
<p>The project status is <span style="color:green;font-weight:bold">GREEN</span> even though the bug count / developer may be in <span style="color:red;font-weight:bold">red.</span> - Capability of span
<p><small>Disclaimer: Wiki also supports showing small text</small></p>
<p><big>Bigger text</big></p>

Ergebnis: