Atribut yang dapat digunakan kembali

Tim Dokumentasi Fedora <https://discussion.fedoraproject.org/tag/docs> v0.0.1, 2024-06-25

Halaman ini menjelaskan cara menggunakan metadata yang dapat digunakan kembali, atau atribut, di seluruh dokumen AsciiDoc dalam Dokumentasi Fedora.

Mengapa atribut yang dapat digunakan kembali?

Terkadang Anda mungkin ingin menggunakan data yang sama di banyak dokumen AsciiDoc. Beberapa contohnya adalah sebagai berikut:

  • Rilis versi (misalnya Fedora N)

  • Prefiks atau sufiks URL (misalnya https://pagure.io/fesco/issues/)

  • Tanggal dan waktu (misalnya tahun saat ini, seperti 2020)

Untuk kasus penggunaan ini dan lainnya, atribut memungkinkan Anda untuk mendefinisikan metadata di satu tempat, dan menggunakannya kembali di beberapa tempat.

Ringkasan

Ada dua persyaratan agar proyek dokumentasi Fedora Anda dapat menggunakan atribut.

  1. Buat berkas atribut

  2. Impor atribut dalam berkas AsciiDoc Anda

Buat berkas atribut

Pertama, buat berkas attributes.adoc untuk setiap modul. Contoh di bawah ini menunjukkan berkas atribut yang dapat digunakan secara global di modul ROOT:

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

Ini adalah contoh attributes.adoc dari Tim Fedora DEI:

// This is a data store of information about the Fedora DEI team.

// Team name:
:team_name: Fedora Diversity, Equity, & Inclusion (DEI) Team

// Team summary:
:team_summary: The {team_name} encourages, supports, and enables DEI in the Fedora community. We work with the community to create an environment where everyone feels empowered to be a part of and contribute to the Fedora Project.

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

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

// Preferred asynchronous communication channel
:team_asynch_communication: https://discussion.fedoraproject.org/tag/dei-team

// Preferred synchronous communication channel
: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 berkas.
:COMMBLOG: https://communityblog.fedoraproject.org
:FISCALYEAR: FY23
:FWIKI: https://fedoraproject.org/wiki
:YEAR: 2023
:MAJOROSVER: 39

Impor atribut

Selanjutnya, impor berkas atribut ke dalam dokumen AsciiDoc Anda. Menempatkan makro ini di baris pertama akan menyelesaikan sisanya:

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

Gunakan atribut dalam dokumentasi

Setelah membuat berkas atribut DAN mengimpor atribut, referensikan atribut tersebut dalam dokumen AsciiDoc dengan sintaks berikut:

{ATTRIBUTE}

Lihat contoh ini dari Tim DEI Fedora:

*Full consensus* is required to approve new processes, make changes to
existing team policies, and tickets requiring
https://budget.fedoraproject.org/budget/{FISCALYEAR}/d-i.html[D&I budget].