Inhalte auf mehreren Seiten wiederverwenden

In diesem Leitfaden finden Sie Informationen dazu, wie Sie Inhalte in DevSite-Artikeln freigeben.

Wenn Sie Inhalte auf mehreren Seiten wiederverwenden möchten, können Sie Variablen und Includes verwenden. Das ist die DevSite-Version der Verwendung von Snippets in mehreren Artikeln in Composer.

Hinweis:Das Cross-Publishing von geteilten Inhalten mit Hilfeartikeln unter support.google.com ist nicht möglich. Sie können in der Navigation auf Seiten aus beliebigen Domains verweisen, aber Sie können einen Artikel oder Abschnitt nicht mit Nicht-DevSite-Domains verlinken.

Wann sollten Includes und Variablen verwendet werden?

  • Verwenden Sie eine Variable, wenn Sie einen kurzen, aus einer einzigen Quelle stammenden Textstring wiederverwenden möchten. Beispiele: Produkt- und Funktionsnamen.

  • Verwenden Sie include, wenn Sie formatierten Text oder HTML aus einer einzigen Quelle wiederverwenden möchten. Das kann z. B. eine Tabelle mit einem Funktionsvergleich oder ein wichtiger Hinweis sein.

Erstellen Sie eine Variable

  1. Öffnen Sie google3/third_party/devsite/workspace/en/_globalvars.html.
    1. Klicken Sie rechts oben auf In Cider bearbeiten.

  2. Fügen Sie eine neue Variablendefinition hinzu.

    {% setvar YOUR_VARIABLE_NAME %}TEXT_TO_DISPLAY{% endsetvar %}
    • Ersetzen Sie YOUR_VARIABLE_NAME durch die Variable, die Sie verwenden möchten.
    • Ersetzen Sie TEXT_TO_DISPLAY durch den Text, der dem Nutzer angezeigt werden soll.

  3. Speichern Sie Ihre Änderungen und senden Sie eine Änderung an workspace-content-configs zur Überprüfung und Genehmigung.

  4. Nachdem der CL eingereicht wurde, können Sie Inhalte mit dem neuen Variablennamen veröffentlichen.

Variable zu Inhalten hinzufügen

Wenn Sie Ihrer Seite eine Variable hinzufügen möchten, verwenden Sie eine Jinja-Variable. Mit dieser einfachen {{ ... }}-Konstruktion wird der Inhalt der angegebenen Variable an der Stelle des Tags auf Ihrer Seite eingefügt.

Beispiel


**Note:** You can buy {{ workspace_name }} from a reseller.

<table>
  <tr>
    <th>Edition</th>
    <th>Cost</th>
  </tr>
  <tr>
    <td>{{ business_plus_sku_name }}</td>
    <td>$50 / month</td>
  </tr>
  <tr>
    <td>{{ business_standard_sku_name }}</td>
    <td>$20 / month</td>
  </tr>
  <tr>
    <td>{{ business_starter_sku_name }}</td>
    <td>No additional cost</td>
  </tr>
</table>

Gerendert

Hinweis:Sie können Google Workspace bei einem Reseller erwerben.

Version Kosten
Business Plus 50 $ pro Monat
Business Standard 20 $ pro Monat
Business Starter Keine zusätzlichen Kosten

Include-Datei erstellen

Wichtig:Include-Dateien müssen immer im HTML-Format vorliegen. Das liegt daran, dass das HTML-Format sowohl in HTML- als auch in Markdown-Codeblockkontexten verwendet werden kann, Markdown-Includes jedoch nur in Markdown-Codeblockkontexten.

Videoanleitung ansehen

So erstellen Sie eine Include-Datei:

  1. Öffnen Sie Cider.

  2. Suchen Sie mit Code Search oder dem Datei-Explorer nach dem Ordner third_party/devsite/workspace/en/_shared/includes/.

  3. Klicken Sie mit der rechten Maustaste auf den Ordner includes und dann auf Neue Datei (Screenshot).

    • Wenn Ihr Include nur für Ihre Inhaltsgruppe relevant ist, können Sie im Ordner /includes einen Unterordner für Ihre Inhaltsgruppe erstellen und dort die Include-Datei hinzufügen. Beispiel: …/workspace/en/shared/includes/cloud-search/_my-niche-snippet.html

  4. Geben Sie der Datei einen Namen und fügen Sie Inhalte hinzu. Befolgen Sie diese Richtlinien:

    • Dateiname muss mit einem Unterstrich beginnen. Beispiel: _my-new-include.html So wird verhindert, dass die Include-Datei extern als eigene Seite angezeigt wird.
    • Dateinamen sollten aussagekräftig sein. So können alle das Include leichter finden und verwenden.
    • Alle Includes müssen HTML-Dateien sein. Die Dateiendung muss .html sein und die Datei darf keine Elemente enthalten, die in Markdown geschrieben sind. So wird sichergestellt, dass der Inhalt korrekt gerendert wird, unabhängig davon, ob er in einer Markdown-Datei, einer HTML-Datei oder einem HTML-Element in einer Markdown-Datei enthalten ist.
    • Vielseitige Inhalte erstellen: Das Ziel eines Include ist, dass es auf mehrere Seiten passt. Die Inhalte sollten daher so wiederverwendbar wie möglich sein. * Idealerweise enthaltene Inhalte: Schritte und zugehörige Hinweise oder Tipps mit Implementierungsdetails wie Einschränkungen, Vorbehalte oder Funktionsweise. * Vermeiden: Überschriften oder Übersichten (wir möchten diese selbst für geschäftliche Anwendungsfälle formatieren und schreiben).

Beispiel:Im Folgenden sehen Sie ein Beispiel für eine Include-Datei mit einer Anleitung zum Kopieren der Projektnummer eines Google Cloud-Projekts:

third_party/devsite/workspace/en/_shared/includes/_copy-cloud-project-number-steps.html

Weitere Informationen finden Sie in der DevSite Publishing-Dokumentation unter Dateien einfügen.

Include-Anweisung in Inhalte einfügen

Verwenden Sie ein include-Tag, um ein Include auf Ihrer Seite hinzuzufügen. Mit dem Tag include wird der Inhalt der angegebenen Datei an der Stelle des Tags auf Ihrer Seite eingefügt.

Hier sehen Sie ein Beispiel für ein Include-Tag für die Beispieldatei aus dem vorherigen Abschnitt:

Beispiel


{% include "_shared/includes/_copy-cloud-project-number-steps.html" %}

Gerendert

  1. Rufen Sie in der Google Cloud Console das Menü  und dann IAM & Verwaltung und dann Einstellungen auf.

    Weiter zur Seite „IAM & Verwaltung“

  2. Kopieren Sie den Wert aus dem Feld Projektnummer.

Migrierte Snippet-Dateien

Snippets aus Composer wurden in den Ordner third_party/devsite/workspace/en/_shared/snippets migriert. Wenn in Ihren Inhalten in Composer Snippets verwendet wurden, bevor sie zu DevSite migriert wurden, sehen Sie in Ihren Inhalten Include-Tags, die dem folgenden Beispiel ähneln:

{% include "_shared/snippets/_snippet-9393389.html" %}

Fügen Sie dem Ordner _shared/snippets keine neuen Include-Dateien hinzu.

Cross-Publishing

In DevSite gehört jede Seite zu einem Inhaltssatz. Devsite unterstützt nicht die in Composer verwendete Cross-Publishing-Funktion, bei der eine Seite in mehreren Hilfezentren veröffentlicht werden kann. Stattdessen können Sie in Ihrem Inhaltsverzeichnis Links zu Seiten in anderen Inhaltssätzen einfügen.

Seite aus einem anderen Inhaltssatz zur Navigation hinzufügen

So verknüpfen Sie eine Seite aus einem anderen Inhaltssatz in Ihrer Navigation:

  1. Öffnen Sie die Datei _book.yaml für Ihr Content-Set. In der Datei _book.yaml verwalten Sie die Navigation Ihrer Website.
  2. Fügen Sie den Seitentitel und den Stamm-Pfad der Seite hinzu, auf die Sie verlinken möchten.

Im folgenden Beispiel verweist die Datei _book.yaml für Cloud Search auf einen Artikel aus der Inhaltsgruppe „Business Continuity“.

    - name: "Guides"
      contents:
      - heading: "Getting started"
      - title: "What is Google Cloud Search?"
        path: /cloud-search/what-is-google-cloud-search 
      - title: "Deploy 2-Step Verification"
        path: /business-continuity/security-and-monitoring/deploy-2-step-verification

Wenn ein Nutzer in der Cloud Search-Navigation auf den Link „2‑Faktor-Authentifizierung bereitstellen“ klickt, wird er zur Seite in der Dokumentation zur Geschäftskontinuität weitergeleitet.

Weitere Informationen zum Aktualisieren der Navigation Ihrer Website