Attributi riutilizzabili

Team di documentazione Fedora <https://discussion.fedoraproject.org/tag/docs> v0.0.1, 2024-06-25

Questa pagina spiega come utilizzare metadati riutilizzabili, o attributi, su più documenti AsciiDoc nella documentazione Fedora.

Perché attributi riutilizzabili?

A volte potresti voler utilizzare gli stessi dati su molti documenti AsciiDoc. Alcuni esempi sono di seguito:

  • Rilasci di versione (ad esempio Fedora N)

  • Prefissi o suffissi URL (ad esempio https://pagure.io/fesco/issues/)

  • Date e ora (ad esempio anno corrente, come "2020")

Per questi e altri casi d’uso, gli attributi consentono di definire alcuni metadati in un unico posto e riutilizzarli in più posti.

Panoramica

Ci sono due requisiti affinché il tuo progetto di documentazione Fedora utilizzi gli attributi.

  1. Creare un file di attributi

  2. Importa gli attributi nel tuo file AsciiDoc

Creare il file degli attributi

Innanzitutto, inizializza un file attributes.adoc per qualsiasi modulo. L’esempio seguente mostra un file di attributi riutilizzabile a livello globale nel modulo "ROOT":

.
└── RADICE
    ├── nav.adoc
    ├── pagine
    │   └── indice.adoc
    └── parziali
        └── attributi.adoc

Questo è un esempio di attributes.adoc da Fedora DEI Team:

// Questo è un archivio dati di informazioni sul team Fedora DEI.

// Nome della squadra:
:team_name: Team Fedora Diversità, Equità e Inclusione (DEI).

// Riepilogo della squadra:
:team_summary: Il {team_name} incoraggia, supporta e abilita il DEI nella comunità Fedora. Lavoriamo con la comunità per creare un ambiente in cui tutti si sentano autorizzati a far parte e a contribuire al progetto Fedora.

// URL della pagina del team:
:team_url: https://docs.fedoraproject.org/it/dei/

// Stato dell'attività del team.
// Scegli tra: Attivo, Inattivo
:team_status: Attivo

// Canale di comunicazione asincrono preferito
:team_asynch_communication: https://discussion.fedoraproject.org/tag/dei-team

// Canale di comunicazione sincrono preferito
:team_synch_communication: https://matrix.to/#/#dei:fedoraproject.org

// Tracker dei problemi
:team_issue_tracker: https://gitlab.com/fedora/dei/home/

// Incontri
:team_meetings: https://apps.fedoraproject.org/calendar/diversity-team/

// Importato dal nostro vecchio file degli attributi.
:COMMBLOG: https://communityblog.fedoraproject.org
:ANNO FISCALE: FY23
:FWIKI: https://fedoraproject.org/wiki
:ANNO: 2023
:MAJOROSVER: 39

Importa attributi

Successivamente, importa il file degli attributi nel tuo documento AsciiDoc. Posizionando questa macro sulla riga superiore farà il resto:

include::ROOT:partial$attributes.adoc[]

Utilizzare gli attributi nella documentazione

Dopo aver creato un file di attributi AND importa attributi, fare riferimento agli attributi nei documenti AsciiDoc con la seguente sintassi:

{ATTRIBUTO}

Guarda questo esempio dal Fedora DEI Team:

Per approvare nuovi processi e apportare modifiche è necessario il *pieno consenso*
politiche del team esistenti e richieste di ticket
https://budget.fedoraproject.org/budget/{FISCALYEAR}/d-i.html[budget D&I].

Want to help? Learn how to contribute to Fedora Docs ›