Ponowne wykorzystywanie treści na różnych stronach

Ten przewodnik zawiera informacje o tym, jak udostępniać treści w artykułach w DevSite.

Aby ponownie wykorzystać treści na wielu stronach, możesz użyć zmiennych i plików dołączanych, czyli wersji DevSite, która umożliwia używanie fragmentów kodu w wielu artykułach w Composerze.

Uwaga: nie można publikować treści udostępnionych w Centrum pomocy na stronie support.google.com. W nawigacji możesz umieszczać linki do stron z dowolnej domeny, ale nie możesz tworzyć jednego źródła artykułu lub sekcji z domenami innymi niż DevSite.

Kiedy używać plików dołączanych i zmiennych

• Użyj zmiennej, jeśli chcesz ponownie wykorzystać krótki ciąg tekstowy pochodzący z jednego źródła. Na przykład nazwy produktów i funkcji.

• Użyj include, jeśli chcesz ponownie wykorzystać sformatowany tekst lub kod HTML z jednego źródła. Może to być na przykład tabela porównawcza funkcji lub ważna uwaga.

Utwórz zmienną

1. Otwórz google3/third_party/devsite/workspace/en/_globalvars.html.
   1. W prawym górnym rogu kliknij Edytuj w Ciderze.

2. Dodaj nową definicję zmiennej.

   • Spróbuj dopasować nową zmienną do jednego z nagłówków kategorii w pliku. W razie potrzeby możemy dodać nowe.
   • Każda kategoria powinna być ułożona alfabetycznie według nazwy zmiennej.

   • Sprawdź, czy nowa nazwa zmiennej nie jest już używana w jednym z tych plików zmiennych:

     • google3/googledata/devsite/_common/en/_shared/_product_names.html

   • google3/googledata/devsite/_common/en/_shared/workspace/_product_names.html

   • google3/googledata/devsite/_common/en/_shared/cloud/_product_names.html

   {% setvar YOUR_VARIABLE_NAME %}TEXT_TO_DISPLAY{% endsetvar %}

   • Zastąp YOUR_VARIABLE_NAME zmienną, której chcesz użyć.
   • Zastąp znak TEXT_TO_DISPLAY tekstem, który ma się wyświetlać użytkownikowi.

3. Zapisz zmiany i wyślij listę zmian na adres workspace-content-configs w celu sprawdzenia i zatwierdzenia.

4. Po przesłaniu listy zmian możesz publikować treści, używając nowej nazwy zmiennej.

Dodawanie zmiennej do treści

Aby dodać zmienną do strony, użyj zmiennej Jinja. Ta prosta konstrukcja {{ ... }} wstawia zawartość określonej zmiennej w miejscu tagu na stronie.

**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>

Tworzenie pliku dołączanego

Ważne: pliki dołączane muszą być zawsze w formacie HTML. Dzieje się tak, ponieważ format HTML może działać zarówno w kontekście bloku kodu HTML, jak i Markdown, ale format Markdown działa tylko w kontekście bloku kodu Markdown.

Obejrzyj film z samouczkiem

Aby utworzyć plik dołączany, wykonaj te czynności:

1. Otwórz Cider.

2. Użyj wyszukiwarki kodu lub eksploratora plików, aby znaleźć folder third_party/devsite/workspace/en/_shared/includes/.

3. Kliknij prawym przyciskiem myszy folder includes i wybierz New File (zrzut ekranu).

   • Jeśli plik dołączany jest istotny tylko dla Twojego zestawu treści, możesz utworzyć podfolder dla tego zestawu w folderze /includes i dodać do niego plik dołączany. Na przykład:…/workspace/en/shared/includes/cloud-search/_my-niche-snippet.html

4. Nadaj plikowi nazwę i dodaj treść. Skorzystaj z tych wskazówek:

   • Zacznij nazwę pliku od podkreślenia. Na przykład:_my-new-include.html. Zapobiega to przekształceniu pliku dołączanego w osobną stronę zewnętrzną.
   • Nadaj plikowi opisową nazwę. Dzięki temu każdy będzie mógł łatwiej znaleźć i użyć tego pliku.
   • Wszystkie pliki dołączane muszą być plikami HTML. Plik musi mieć rozszerzenie .html i nie może zawierać żadnych elementów zapisanych w Markdown. Dzięki temu treść będzie się prawidłowo renderować niezależnie od tego, czy jest zawarta w pliku Markdown, pliku HTML czy elemencie HTML w pliku Markdown.
   • Zadbaj o wszechstronność treści. Celem dołączenia jest dopasowanie go do wielu stron, więc treść powinna być jak najbardziej wielokrotnego użytku. * Idealne treści: kroki i powiązane z nimi uwagi lub wskazówki zawierające szczegóły wdrożenia, takie jak limity, zastrzeżenia lub sposób działania. * Unikaj: nagłówków i streszczeń (chcemy je sami formatować i pisać na potrzeby biznesowe).

Przykład: poniżej znajdziesz przykład pliku dołączanego z instrukcjami kopiowania numeru projektu w chmurze Google Cloud:

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

Więcej informacji znajdziesz w dokumentacji DevSite Publishing dotyczącej dołączania plików.

Dodawanie do treści instrukcji include

Aby dodać do strony dołączenie, użyj tagu include. Tag include wstawia zawartość określonego pliku w miejscu, w którym znajduje się tag na stronie.

Oto przykład tagu include dla pliku przykładowego z poprzedniej sekcji:

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

Przeniesione pliki z fragmentami kodu

Fragmenty z Composer zostały przeniesione do folderu third_party/devsite/workspace/en/_shared/snippets. Jeśli Twoje treści korzystały ze snippetów w Composerze przed przeniesieniem do DevSite, zobaczysz w nich tagi include podobne do tego przykładu:

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

Nie dodawaj nowych plików dołączanych do folderu _shared/snippets.

Publikowanie na różnych platformach

W DevSite każda strona należy do jednego zestawu treści. Devsite nie obsługuje publikowania krzyżowego używanego w Composerze, w którym jedna strona może być publikowana w wielu centrach pomocy. Zamiast tego możesz utworzyć linki do stron w innych zestawach treści z poziomu spisu treści.

Dodawanie strony z innego zestawu treści do menu nawigacyjnego

Aby utworzyć w obszarze nawigacyjnym link do strony z innego zestawu treści, wykonaj te czynności:

1. Otwórz plik _book.yaml dla zestawu treści. Plik _book.yaml służy do zarządzania nawigacją w witrynie.
2. Dodaj tytuł strony i ścieżkę główną do strony, do której chcesz dodać link.

W poniższym przykładzie _book.yaml plik Cloud Search zawiera link do artykułu z zestawu treści dotyczących ciągłości działania firmy.

    - 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
      

Gdy użytkownik kliknie link Wdróż weryfikację dwuetapową w nawigacji Cloud Search, zostanie przekierowany na stronę w dokumentacji dotyczącej ciągłości działania.

Więcej informacji o aktualizowaniu nawigacji w witrynie znajdziesz w artykule Aktualizowanie nawigacji.