Bagaimana cara mengutip simbol dalam string dokumentasi?

8

Dalam dokumentasi Emacs Lisp, saya sering menemukan simbol yang dikutip seperti `buffer-file-name'di dalam dokumen . Yang menarik di sini adalah gaya mengutip, dengan mengelilingi nama simbol dengan backtick dan kutipan. Saya ingin tahu dari mana gaya ini berasal. Menurut jawaban ini bisa terkait dengan rangkaian karakter terbatas.

Hal lain yang perlu diperhatikan adalah bahwa simbol-simbol yang dikutip ini memiliki penyorotan sintaks emacs-lisp-mode, sedangkan simbol-simbol yang dikutip hanya dengan tanda kutip tunggal, misalnya, 'buffer-file-name', tidak mendapatkan penyorotan sintaksis apa pun.

Jadi ini menunjukkan bahwa sintaks backtick-quote harus menjadi konvensi terkenal di Emacs. Tetapi setelah googling dokumentasi, saya tidak dapat menemukannya disebutkan di mana saja. Dalam manual Emacs Lisp ada bagian bernama "Tip untuk String Dokumentasi" ; ia mengatakan

Ketika string dokumentasi mengacu pada simbol Lisp, tulislah sebagaimana akan dicetak (yang biasanya berarti huruf kecil), dengan tanda kutip tunggal di sekitarnya.

tetapi tidak menyebutkan gaya mengutip.

Ketik C-h f thing-at-point RETlalu klik tautan ke kode sumber untuk melihat beberapa contoh gaya kutipan lainnya:

(defun thing-at-point (thing & opsional no-properties) "Kembalikan
HAL pada titik. HAL harus merupakan simbol yang menentukan jenis
entitas sintaksis. Kemungkinan termasuk` simbol ', `daftar',` sexp ',
`defun' , `nama file ',` url', `email ',` word', `kalimat ',` whitespace',
`line ',` number', dan `page '.

Ketika argumen opsional NO-PROPERTI adalah nihil, cabut
properti teks dari nilai kembali.

Lihat file `thingatpt.el 'untuk dokumentasi tentang cara mendefinisikan
simbol sebagai HAL yang valid."

Jadi semua ini memberikan indikasi bahwa seseorang harus menggunakan gaya kutipan-backtick untuk mengutip simbol, tetapi apakah gaya ini didokumentasikan di mana saja?

Håkon Hægland
sumber
1
Apakah Anda lebih tertarik untuk menemukan dokumentasi pada simbol `kutip ', atau Anda ingin tahu untuk apa itu? Jika yang terakhir, itu untuk tujuan referensi silang: Anda bisa mengklik simbol-simbol itu di buffer bantuan, dan itu akan membawa Anda ke buffer bantuan yang sesuai untuk simbol yang Anda klik.
Dan
1
Catatan tambahan, jika Anda menggunakan font dengan karakter unicode, Anda bisa memodifikasi tabel tampilan untuk menggunakan karakter yang lebih baik untuk tanda kutip. Atau, Anda dapat menggunakan font-lock untuk mengenali huruf khusus dari `simbol '.
Lindydancer

Jawaban:

11

Konvensi ini didokumentasikan di bagian yang sudah Anda referensikan (Tip untuk String Dokumentasi). Tujuan kutipan disebutkan, dan contoh disediakan:

 Help mode automatically creates a hyperlink when a documentation
 string uses a symbol name inside single quotes ... For example, if
 you write

      This function sets the variable `buffer-file-name'.

Sepertinya hal yang membuat Anda penasaran adalah mengapa single quotesdalam konteks ini benar-benar berarti

`this' 

daripada

'this'

Representasi karakter kutipan kiri dan kanan ini menggunakan ASCII backtick (aksen kubur) dan kutipan tunggal (apostrof) tampaknya telah menjadi konvensi UNIX yang umum pada satu titik, dan karena itu saya curiga tidak ada gunanya menjelaskan lebih lanjut ketika manual Emacs Sudah ditulis.

Menurut posting ini , font Sistem X Window lama dan font istilah membuat simbol-simbol ini lebih mirip dengan kutipan yang benar.

glukas
sumber