Reutilizáveis são cadeias de caracteres longas de texto reutilizável, como parágrafos ou listas de procedimentos, que podem ser referenciados em vários arquivos de conteúdo.
Usamos o Markdown (em vez do YAML) para reutilizáveis. O Markdown possibilita que o pipeline de localização divida as cadeias de caracteres em segmentos traduzíveis menores, resultando em menos erros de tradução e menos rotatividade quando o conteúdo em inglês de origem é alterado.
Cada reutilizável está localizado em um arquivo Markdown próprio.
O caminho e o nome de arquivo de cada arquivo Markdown determinam qual será o caminho dele no objeto de dados. Por exemplo, um arquivo chamado /data/reusables/foo/bar.md
estará acessível como {% data reusables.foo.bar %}
nas páginas.
Em geral, os arquivos reutilizáveis são divididos em diretórios por tarefa. Por exemplo, se você estiver criando uma cadeia de caracteres reutilizável para artigos sobre as notificações do , você a adicionará no diretório data/reusables/notifications/
em um arquivo chamado data/reusables/notifications/YOUR-REUSABLE-NAME.md
. A referência de conteúdo que você adicionará à origem será semelhante a {% data reusables.notifications.YOUR-REUSABLE-NAME %}
.
Os reutilizáveis podem incluir condicionais do Liquid para renderizar condicionalmente o conteúdo, dependendo da versão atual que está sendo exibida.
As variáveis são cadeias de caracteres curtas de texto reutilizável.
Usamos arquivos YAML para as variáveis.
O caminho, o nome de arquivo e as chaves de cada arquivo YAML determinam qual será o caminho dele no objeto de dados.
Por exemplo, este arquivo YAML, data/variables/foo/bar.yml
, contém duas variáveis:
# the YAML file can contain multiple short strings in one file
meaning_of_life: 42
# the strings can also be nested if needed
nested:
values:
too: Yes!
Os valores poderão ser acessados como {% data foo.bar.meaning_of_life %}
e {% data foo.bar.nested.values.too %}
.