Uudelleenkäytettävät ominaisuudet

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

Tämä sivu selittää, kuinka uudelleenkäytettäviä metatietoja tai attribuutteja käytetään useissa AsciiDoc-dokumenteissa Fedora-dokumentaatiossa.

Miksi uudelleenkäytettävät ominaisuudet?

Joskus saatat haluta käyttää samoja tietoja useissa AsciiDoc-asiakirjoissa. Alla on joitakin esimerkkejä:

Näissä ja muissa käyttötapauksissa attribuutit mahdollistavat metatietojen määrittämisen yhdessä paikassa ja sen uudelleenkäytön useissa paikoissa.

Yleiskatsaus

Fedora Documentation -projektisi ominaisuuksien käyttämiseksi on kaksi vaatimusta.

  1. Luo attribuuttitiedosto

  2. Tuo attribuutit AsciiDoc-tiedostoosi

Luo ominaisuustiedosto

Alusta ensin attributes.adoc-tiedosto mille tahansa moduulille. Alla oleva esimerkki näyttää globaalisti uudelleenkäytettävän attribuuttitiedoston ROOT-moduulissa:

.
└── ROOT
    ├── nav.adoc
    ├── pages
    │   └── index.adoc
    └── partials
        └── attributes.adoc

Tämä on esimerkki tiedostosta attributes.adoc tiedostosta Fedora DEI Team:

// Tämä on tietovarasto, joka sisältää tietoja Fedora DEI -tiimistä.

// Joukkueen nimi:
:team_name: Fedoran monimuotoisuus-, tasa-arvo- ja osallisuustiimi (DEI)

// Joukkueen yhteenveto:
:team_summary: {team_name} kannustaa, tukee ja mahdollistaa monimuotoisuuden ja vuorovaikutuksen Fedora-yhteisössä. Työskentelemme yhteisön kanssa luodaksemme ympäristön, jossa jokainen tuntee voivansa olla osa Fedora-projektia ja osallistua siihen.

// Team page URL:
:team_url: https://docs.fedoraproject.org/en-US/dei/

// Team activity status.
// Choose from: Active, Inactive
:team_status: Active

// Ensisijainen asynkroninen viestintäkanava
:team_asynch_communication: https://discussion.fedoraproject.org/tag/dei-team

// Ensisijainen synkroninen tiedonsiirtokanava
:team_synch_communication: https://matrix.to/#/#dei:fedoraproject.org

// Issue tracker
:team_issue_tracker: https://gitlab.com/fedora/dei/home/

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

// Imported from our old attributes file.
:COMMBLOG: https://communityblog.fedoraproject.org
:FISCALYEAR: FY23
:FWIKI: https://fedoraproject.org/wiki
:YEAR: 2023
:MAJOROSVER: 39

Tuo attribuutit

Seuraavaksi tuo attribuuttitiedosto AsciiDoc-dokumenttiin. Tämän makron sijoittaminen yläriviin hoitaa loput:

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

Use attributes in documentation

Kun olet luonut attribuuttitiedoston JA tuo attribuutit, viittaa AsciiDoc-dokumenttien attribuutteihin seuraavalla syntaksilla:

{ATTRIBUTE}

Katso tämä esimerkki Fedora DEI -tiimiltä:

Englanti
*Täysi konsensus* vaaditaan uusien prosessien hyväksymiseen, muutosten tekemiseen
[##]olemassa oleviin tiimikäytäntöihin ja tiketteihin, jotka vaativat

https://budget.fedoraproject.org/budget/{FISCALYEAR}/d-i.html[D&I budget].

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