Menulis Dokumen ala RFC

I Made Wiryana dan Tedi Heriyanto1

Ringkasan:

Tulisan ini akan mengisahkan bagaimana cara membuat sebuah dokumen yang sesuai dengan model RFC. Diharapkan dengan berpanduan pada tulisan ini, maka para penulis dapat menghasilkan dokumen yang seragam formatnya sehingga mudah dibaca. Pertama-tama akan dibahas mengenai penulisan dokumen menggunakan teks editor vi ataupun editor teks lain, selanjutnya akan dibahas mengenai cara memformat dokumen tersebut menggunakan program nroff (atau program groff dari GNU) dan paket makro -ms.

Pendahuluan

Dokumen ini akan memberikan gambaran singkat, mengenai bagaimana cara menyiapkan dokumen yang akan digunakan dalam proses RFC. Tujuan utama penulisan dokumen ini adalah agar memberikan panduan bagi para penulis dokumen dalam menghasilkan dokumen yang memiliki format seragam, portabel, dan bersifat open.

Beberapa buah tools, misalnya program nroff dan paket makro -ms dan editor vim, yang digunakan dalam pembuatan dokumen RFC semuanya bersifat open source.

Menyiapkan Dokumen

Pertama-tama yang perlu dilakukan dalam membuat dokumen adalah menyiapkan dokumen tersebut.

Mengetik Dokumen

Dokumen yang ditujukan bagi RFC proses ini haruslah diketik dalam lingkungan sistem operasi UNIX2, agar memudahkan proses pemformatan selanjutnya. Untuk melakukan pengetikan ini dapat digunakan teks editor yang umum tersedia di lingkungan sistem operasi UNIX misalnya VIM ataupun Emacs, meski tidak menutup kemungkinan juga untuk menggunakan teks editor lainnya.

Bagi anda yang ingin belajar mengenai teks editor lebih lanjut terdapat banyak sekali tutorial yang beredar di Internet yang membahasnya. Salah satunya adalah tutorial yang dibuat oleh salah satu penulis dokumen ini dan dapat diperoleh di http://www.tedi-h.com/papers/tut-vi.html

Konversi dari MS-Word/Word Prosesor Lain

Jika anda telah terlanjur mengetik menggunakan MS Word, jangan kuatir, dokumen yang telah anda ketik tersebut masih dapat kita gunakan sebagai dokumen RFC.

Untuk melakukannya diperlukan beberapa langkah sederhana yang mesti dilakukan di dalam lingkungan sistem operasi Windows dan sistem operasi UNIXes:

Berikut ini adalah langkah-langkah yang dapat anda lakukan pada saat anda berada di lingkungan Windows :

Berikut ini adalah langkah-langkah yang dapat anda lakukan pada saat anda berada di lingkungan UNIXes :

Penamaan File Dokumen

Dokumen yang telah selesai diketik tadi kemudian disimpan ke dalam sebuah file teks murni.

Memformat Dokumen

Untuk memformat dokumen yang telah selesai dibuat tadi, digunakan program nroff. Biasanya program ini sudah terinstalasi secara baku di dalam sistem komputer anda.

Pengenalan nroff

GNU Troff (atau nroff) adalah suatu sistem untuk typesetting dokumen. Troff sangat fleksibel dan telah ada (dan digunakan) selama hampir dua dekade. Ia cukup tersebar luas dan sangat dikenal di komunitas UNIX [3].

Secara sederhana, fungsi program nroff adalah menerjemahkan perintah-perintah layout yang dimasukkan dalam suatu file, yaitu file anda. Dengan demikian anda dapat menentukan output tampilan file dokumen anda dengan menggunakan nroff, anda tidak perlu bingung memikirkan bagaimana nanti tampilan dokumen anda karena telah diformat secara konsisten dengan nroff.

Berikut ini adalah beberapa buah kemampuan nroff [3]:

Oleh karena nroff memberikan fasilitas-fasilitas level rendah, akan cukup sulit digunakan bagi pemakai. Namun, nroff menyediakan sebuah fasilitas makro yang memungkinkan anda menspesifikasikan bagaimana operasi rutin tertentu dilakukan, misalnya memulai paragraf, mencetak header dan footer, dan sebagainya. Makro-makro ini dapat dikelompokkan bersama ke dalam sebuah paket makro. Terdapat sejumlah paket makro yang tersedia, yang paling umum adalah -man -me, -ms dan -mm. Dalam dokumen ini kita akan menggunakan paket makro -ms.

nroff membaca sebuah file input yang disiapkan oleh pemakai dan menghasilkan sebuah file yang sesuai untuk dipublikasikan atau dicetak. Input terdiri dari teks, atau kata-kata untuk dicetak, dan perintah-perintah yang disertakan (permintaan dan escape), yang memberitahu nroff bagaimana memformat salinan tercetak.

Perintah program nroff yang digunakan

Kata argumen digunakan dalam dokumen ini untuk menyatakan kata atau bilangan yang muncul pada baris yang sama dengan sebuah perintah yang memodifikasi arti perintah tersebut. Sebagai contoh, perintah :

.sp
berarti spasi satu baris, tetapi

.sp 4
berarti spasi empat baris

Angka 4 adalah sebuah argumen bagi perintah sp yang menyatakan jumlah spasi empat baris alih-alih satu baris. Argument dipisahkan dari perintah dan satu sama lainnya dengan spasi.

Fungsi utama nroff adalah mengumpulkan kata-kata dari baris input, mengisi baris-baris output dengan kata-kata tersebut, meratakan margin kana dengan menambahkan spasi di baris tersebut, dan memberikan hasilnya.

Sebagai contoh, input:

Now is the time

for all good men

to come to the aid

of their party.

Four score and seven

years ago,...
akan dibaca, dipaket ke dalam baris-baris output, dan diratakan sehingga menghasilkan :

Now is the time for all good men to come to the aid of their party. Four score and seven years ago,...
Terkadang anda ingin memulai sebuah baris output baru meskipun baris yang sekarang belum penuh, sebagai contoh pada akhir sebuah paragraf. Untuk melakukan ini anda dapat membuat sebuah break, yang memulai sebuah baris baru.

Tidak seluruh baris input adalah teks yang ingin diformat. Beberapa baris input adalah perintah yang menggambarkan bagaimana memformat teks. Perintah-perintah ini selalu dimulai dengan tanda titik atau apostrophe (`'').

Pemformat teks juga melakukan beberapa hal kompleks lainnya, seperti secara otomatis menyisipkan nomor halaman, menempatkan footnode di tempat yang tepat, dan sebagainya.

Cukup basa-basinya mengenai kemampuan nroff, mari kita langsung membahas perintah-perintahnya.

.pl n

Panjang halaman diset ke n, yang dapat dispesifikasikan dalam sembarang unit: 10.1 i menghasilkan halaman dengan panjang 9 inchi.

.po n

Perintah ini digunakan untuk mengeset ofset halaman. Beri nilai 0, untuk mengeset ofset ke paling kiri halaman.

.ll n

Perintah ini digunakan untuk mengeset panjang halaman. Secara bakunya, nroff mengeset panjang halaman 6,5 inchi.

.lt

.nr LL

.nr LT

.ds LF Tedi Heriyanto

.ds RF RFCID [Hlm. %]

.ds CF

.ds LH RFCID 1000

.ds RH 1 Juni 2001

.ds CH Pengiriman Data Wireless lewat Telepati

.hy

.ad [l|r]

Sesuaikan kedua buah margin, ini adalah mode penyesuaian baku.

.sp n

Berikan n baris kosong pada ruang ini dalam output. Jika n dihilangkan, perintah ini menempatkan satu baris kosong (nilai saat ini unit v). Anda dapat memberikan unit dimensi bagi n untuk menspesifikasikan kuantitas dalam unit alih-alih dalam jumlah baris kosong.

.ce n

Perintah ini digunakan untuk meratatengahkan n baris teks input berikut secara individu dalam output. Jika n dihilangkan, hanya baris berikut teks yang akan diratatengahkan.

.fi

.in n

Perintah ini digunakan untuk mengeset margin kiri halaman terindentasi sejumlah n dari ofset halaman.

ti n

Perintah ini digunakan untuk mengeset indentasi sementara. Secara baku, unit yang digunakan adalah ems.

Unit Pengukuran Independen Terhadap nroff

Beberapa unit pengukuran benar-benar independen dengan setting nroff yang ada saat ini (misalnya ukuran tipe) of nroff.

Unit Keterangan
i Inci. Unit pengukuran antik yang masih digunakan di beberapa negara terbelakang tertentu.
c sentimeter
p Poin. Ini adalah ukuran typesetter yang digunakan untuk mengukur ukuran tipe. Ada 72 poin dalam satu inci.
P Pica. Ukuran typesetting yang lain. Ada 6 pica dalam satu inci.

Unit Pengukuran Dependen Terhadap nroff

Ukuran lain yang dikenal oleh nroff adalah dependen dengan setting saat ini. Sangat berguna untuk menspesifikasikan ukuran yang tampak sesuai dengan sembarang ukuran teks.

Unit Keterangan
m Em. Unit ini setara dengan ukuran font saat ini dalam point. Disebut demikian karena ia mendekati lebar huruf `m' di font saat ini.
n En. Setengah dari sebuah em.
v Spasi vertikal. Setara dengan spasi baris saat ini.
M 1/100 dari sebuah em.

Contoh File Yang Siap Diformat nroff

Sebuah contoh file yang siap diformat menggunakan nroff dapat diperoleh di http://www.tedi-h.com/projects/rfc/rfcid1000

Menghasilkan Output

Sebelum dapat menggunakan nroff, terlebih dahulu anda harus mendownload program fix.pl dari http://www.tedi-h.com/projects/rfc/fix.pl

Untuk menghasilkan output dari file yang telah diformat tersebut, dapat diberikan perintah berikut ini :

nroff -ms file_input | ./fix.pl > file_output

Penutup

Demikianlah uraian singkat kami mengenai penggunaan beberapa buah tool untuk membuat dokumen RFC. Kami berharap semoga dokumen ini dapat digunakan demi kepentingan kita bersama.

Bibliografi

1
Jon Postel, ``RFC nroff macros", 1991, http://www.ietf.org/internet-drafts/2-nroff.template

2
Jan Pardoe, ``UNIX Text Formatting Using the -ms Macros'', 1995, http://www.cs.berkeley.edu/janp/Help/textms.html

3
Free Software Foundation, groff Manual, http://www.cs.pdx.edu/trent/gnu/groff/groff.html, 1992

4
Jon Postel dan Joyce Reynolds, ``Instructions to RFC Authors'', RFC2233, ftp://ftp.isi.edu/in-notes/rfc2223.txt



Footnotes

... Heriyanto1
Software Engineer, dapat dihubungi di tedi_h@gmx.net
... UNIX2
Sistem operasi UNIX di sini mengacu pula kepada variannya, misalnya BSD dan Linux


Tedi Heriyanto 2001-06-11