Menggunakan Counter di Asciidoc
Selama saya menggunakan Asciidoctor, sering kali kita membutuhkan penomoran otomatis. Misalnya untuk langkah-langkah, contoh penggunaan, atau penanda urutan tanpa harus mengetik angka secara manual.
Asciidoctor menyediakan fitur counter attribute, yaitu atribut dokumen yang nilainya otomatis bertambah setiap kali digunakan. Fitur ini sangat berguna agar dokumentasi tetap konsisten dan mudah dirawat.
Artikel ini akan membahas konsep counter di Asciidoctor, cara penggunaannya, serta contoh penerapannya secara langsung.
Apa Itu Counter di Asciidoctor?
Counter di Asciidoctor adalah document attribute khusus yang nilainya akan bertambah (increment) setiap kali dipanggil menggunakan sintaks tertentu.
Beberapa karakteristik penting counter:
-
Nilai default dimulai dari 1
-
Bisa menggunakan angka atau huruf
-
Huruf yang didukung hanya latin (
a–zatauA–Z) -
Bisa di-increment dengan atau tanpa ditampilkan
Cara Membuat Counter Attribute
Untuk membuat counter, kita harus menambahkan prefix counter: di depan nama atribut.
Contoh dasar
Jika ini pertama kali dipanggil, hasilnya akan menjadi:
Pemanggilan berikutnya:
akan menghasilkan:
Setiap pemanggilan dengan counter: akan menampilkan sekaligus menaikkan nilai counter.
Nilai Counter Tanpa Increment
Jika kita hanya ingin menampilkan nilai saat ini tanpa menaikkan counter, cukup panggil nama atributnya saja (tanpa counter:).
Ini berguna jika kita ingin menampilkan angka yang sama di beberapa tempat tanpa mengubah urutan.
Fungsinya mungkin mirip print di python.
Increment Tanpa Menampilkan Nilai (counter2)
Asciidoctor menyediakan counter2: untuk menaikkan nilai counter tanpa menampilkannya.
Contoh
Perintah ini hanya menaikkan nilai steps, tetapi tidak menampilkan apa pun.
Untuk melihat nilainya setelah itu:
Mengatur Nilai Awal Counter
Secara default counter dimulai dari 1. Namun kita bisa mengatur nilai awal dengan menambahkan suffix :<nilai_awal> saat pertama kali digunakan.
Contoh mulai dari angka 10
Pemanggilan berikutnya:
Hasilnya:
Menggunakan Counter dengan Huruf
Selain angka, counter juga bisa menggunakan huruf.
Untuk memulainya, tentukan nilai awal berupa huruf:
Pemanggilan selanjutnya:
Hasilnya akan menjadi:
Catatan:
-
Hanya mendukung huruf
A–Zataua–z -
Tidak mendukung karakter non-latin
Counter sangat cocok digunakan untuk:
-
Langkah-langkah prosedur
-
Penomoran contoh
-
Urutan konfigurasi
-
Dokumentasi panjang yang sering berubah
-
Menghindari kesalahan penomoran manual
Penomoran gambar secara otomatis
Comments
Post a Comment