notangle - Online di Awan

PROGRAM:

NAMA

notangle, noweave, nountangle - noweb, alat pemrograman terpelajar

RINGKASAN

tidak bersudut [-Rnama akar ...] [-Saring memerintah] [-L[format]] [berkas] ...
kata benda [-ml|-m3|-c|-c++|-awk|-teks|-f77|-f90|-pelat|-matlab] [-Rnama akar ...] [-Saring
memerintah] [-wlebar] [berkas] ...
sekarang [opsi] [file] ...

DESKRIPSI

Tidak ada web adalah alat pemrograman terpelajar seperti Knuth's SITUS, hanya lebih sederhana. A sekarang fillet
berisi kode sumber program yang disisipkan dengan dokumentasi. Kapan tidak bersudut diberikan
sekarang file, ia menulis program pada output standar. Kapan sekarang diberikan sekarang file,
itu membaca sekarang sumber dan menghasilkan, pada output standar, Getah, TeX, troff, atau HTML
sumber untuk dokumentasi pengesetan. kata benda mengubah program melek menjadi program biasa
program dengan mengubah dokumentasi yang disisipkan menjadi komentar. Nama file `-' mengacu pada
masukan standar.

FORMAT OF SEKARANG FILE

A sekarang file adalah urutan dari potongan, yang mungkin muncul dalam urutan apa pun. Sepotong mungkin berisi
kode atau dokumentasi. Potongan dokumentasi dimulai dengan garis yang dimulai dengan tanda
(@) diikuti dengan spasi atau baris baru. Mereka tidak memiliki nama. Potongan kode dimulai dengan
<<bingkah nama>> =
pada baris dengan sendirinya. Tanda kurung siku ganda (<<) harus berada di kolom pertama.
Potongan diakhiri oleh awal potongan lain, atau akhir file. Jika yang pertama
baris dalam file tidak menandai awal dari sebuah potongan, itu dianggap sebagai yang pertama
baris potongan dokumentasi.

Potongan dokumentasi berisi teks yang diabaikan oleh tidak bersudut dan disalin kata demi kata ke
keluaran standar dengan sekarang (kecuali untuk kode yang dikutip). sekarang dapat bekerja dengan Getah, polos
TeX, troff or HTML. Dengan polos TeX, itu menyisipkan referensi ke a TeX paket makro, nwmac,
yang mendefinisikan perintah seperti \Bab dan \bagian.

Potongan kode berisi kode sumber program dan referensi ke potongan kode lainnya. Beberapa kode
potongan mungkin memiliki nama yang sama; tidak bersudut menggabungkan definisi mereka untuk menghasilkan satu
potongan, seperti halnya kekusutan(1). Definisi potongan kode seperti definisi makro;
tidak bersudut mengekstrak program dengan memperluas satu bongkahan (secara default, bongkahan bernama <<*>>).
Definisi potongan itu berisi referensi ke potongan lain, yang merupakan dirinya sendiri
diperluas, dan sebagainya. tidak bersudutkeluarannya dapat dibaca; itu mempertahankan lekukan dari
potongan diperluas sehubungan dengan potongan di mana mereka muncul.

Kode dapat dikutip dalam potongan dokumentasi dengan menempatkan tanda kurung siku ganda ([[...]])
di sekitarnya. Tanda kurung siku ganda ini diabaikan oleh tidak bersudut, tetapi mereka dapat digunakan oleh
sekarang untuk memberikan perlakuan tipografi khusus pada kode, misalnya tautan hypertext. Jika dikutip
kode diakhiri dengan tiga atau lebih tanda kurung siku, sekarang memilih pasangan paling kanan, sehingga,
sebagai contoh, [[a[i]]] diurai dengan benar. Nama-nama potongan kode mungkin muncul di dalam
kode yang dikutip kecuali kode yang dikutip itu sendiri merupakan bagian dari nama potongan kode.

Dalam kode, noweb memperlakukan kurung sudut kiri atau kanan ganda yang tidak berpasangan sebagai literal << dan >>.
Untuk memaksa tanda kurung seperti itu, bahkan tanda kurung berpasangan atau tanda kurung dalam dokumentasi, menjadi
diperlakukan sebagai literal, gunakan tanda sebelumnya (mis @<).

Beberapa bahasa pemrograman atau pemformatan mungkin memerlukan satu @ masuk kolom pertama.
Tidak ada pengguna web yang dapat mencapai efek ini dengan menempatkan dua kali lipat @@ di kolom pertama; di dalam
posisi saja, itu singkatan dari single @ tanda.

JATUH

tidak bersudut dan kata benda menerima set opsi yang sama, meskipun beberapa opsi memiliki efek
hanya pada satu atau yang lain. Pilihannya adalah:

-Rnama Pilih <<nama>> potongan kode. NS -R opsi dapat diulang, dalam hal ini masing-masing
chunk ditulis ke output. Jika tidak -R opsi diberikan, perluas potongan bernama
<<*>>.

-Lformat
Pancarkan indikasi nomor baris pada batas chunk. Indikasi nomor baris
mengidentifikasi sumber garis yang mengikutinya. Di dalam format, %F menunjukkan
nama file sumber, %L menunjukkan nomor baris file sumber, %N
menunjukkan baris baru, dan %% menunjukkan tanda persen. Sebuah tanda dan angka mungkin
disisipkan di antara tanda persen dan `L', dalam hal ini nomor baris akan
disesuaikan dengan jumlah tersebut. Jika format dihilangkan, format defaultnya adalah
diterima oleh preprosesor C: `#garis %L "%F"%N'. Saat menggunakan -Lformat pilihan,
tidak bersudut memastikan bahwa semua teks muncul di kolom yang sama di input dan output.
kata benda mengabaikan opsi ini.

String format umum meliputi:
C -L'#baris %L "%F"%N'
Matahari FORTRAN -L'\# %L "%F"%N'
icon -L'#baris %-1L "%F"%N'
Modul-3 -L'<*LINE %L "%F" **%N'
SML/NJ -L'(*#baris %L "%F"*)'

Untuk memecahkan masalah sebaliknya, yaitu, untuk membuat web melakukan sesuatu yang masuk akal dengan
#garis dalam masukannya, lihat garis tajam filter di direktori contoh.

-tk Salin tab yang tidak tersentuh dari input ke output, dan gunakan tab untuk lekukan, dengan asumsi
berhenti setiap k kolom. Secara default, tab diperluas ke spasi dengan perhentian setiap 8
kolom.

-Saring cmd
Saring sekarang sumber melalui cmd setelah mengubahnya menjadi bentuk alat dan sebelumnya
kekusutan. tidak bersudut mencari cmd pertama di pengguna PATH, lalu masuk /usr/lib/noweb.
Filter semacam itu dapat digunakan untuk menambahkan fitur ke tidak bersudut; untuk contoh lihat
/usr/lib/noweb/emptydefn. Untuk para ahli saja.

-markup pengurai
penggunaan pengurai untuk mengurai file masukan. Memungkinkan penggunaan alat sekarang pada file di lainnya
format; misalnya, markup pengurai mengerti web baru(1) format. Lihat
filter sekarang(7) untuk informasi lebih lanjut. Untuk para ahli saja.

-awk | -c | -icn | -ikon | -ml | -m3 | -pascal | -f77 | -f90 | -teks
Ketika kata benda mengubah potongan dokumentasi menjadi komentar, gunakan komentar
format bahasa bernama. -c adalah defaultnya. tidak bersudut mengabaikan opsi ini.

-wn Ketika kata benda mengubah potongan dokumentasi menjadi komentar, membuat komentar di
garis lebar n. tidak bersudut mengabaikan opsi ini.

TENUN

Keluaran dari sekarang dapat digunakan di TeX mendokumentasikan itu \memasukkan nwmac, in Getah dokumen
yang menggunakan sekarang paket (lihat gaya sekarang(1)), dan masuk HTML dokumen untuk dijelajahi dengan
Mosaik(1). sekarang memperlakukan potongan kode agak seperti Getah daftar lingkungan. Jika ``@
'' yang mengakhiri potongan kode segera diikuti oleh teks, teks itu mengikuti
potongan kode tanpa jeda paragraf. Jika sisa baris kosong, sekarang menempatkan TeX
ke `` mode vertikal,'' dan teks selanjutnya memulai paragraf baru yang menjorok.

Tidak ada jeda halaman yang terjadi di tengah potongan kode kecuali jika diperlukan untuk menghindari terlalu penuh
kotak v Potongan dokumentasi tepat sebelum potongan kode muncul di halaman yang sama
sebagai potongan kode itu kecuali jika melakukannya akan melanggar aturan sebelumnya.

sekarang tidak memasukkan baris baru tambahan di dalamnya TeX output, sehingga nomor baris yang diberikan dalam TeX
pesan kesalahan sama dengan yang ada di file input.

sekarang memiliki opsi yang menentukan pilihan pemformat dan yang mendukung pemformatan berbeda
idiom dan alat. Opsi dasar dijelaskan di sini; opsi yang terkait dengan indeks dan lintas
informasi referensi dijelaskan di bagian PENGINDEKSIAN DAN REFERENSI SILANG.

-getah Keluarkan LaTeX, termasuk pembungkus di artikel gaya dengan sekarang paket dan halaman
gaya. (Bawaan)

-teks Keluarkan TeX biasa, termasuk pembungkus dengan nwmac makro.

-html Memancarkan HTML, menggunakan pembungkus HTML. Outputnya tidak menarik tanpa -indeks or -x.
tag dan , pada baris sendiri, menghasilkan daftar
potongan dan indeks pengidentifikasi, masing-masing. Jika tag ini tidak ada,
daftar dan indeks ditempatkan di akhir file.

-lateks+html
Asumsikan potongan dokumentasi adalah LaTeX, tetapi hasilkan HTML untuk potongan kode, sesuai
ditandai jadi konversi dengan lateks2html(1) menghasilkan output yang wajar. Pembungkus LaTeX
tersirat, tetapi dapat dimatikan dengan -n. penggunaan of ini Option is usang; menggunakan
-html dengan -Saring l2 jam sebagai gantinya.

-trof Memancarkan troff(1) markup (tanpa pembungkus). Hasilnya harus diproses dengan
noroff(1). Laporan bug untuk -trof kepada Aharon Robbins <arnold@gnu.org>.

-n Jangan gunakan pembungkus (tajuk atau cuplikan). Opsi ini berguna ketika sekarang's
output akan menjadi bagian dari dokumen yang lebih besar. Lihat juga -menunda.

-Saring cmd
Filter sekarang sumber melalui cmd setelah mengubahnya menjadi bentuk alat dan sebelumnya
mengkonversi ke TeX. sekarang mencari cmd pertama di pengguna JALUR, lalu masuk
/usr/lib/noweb. Filter semacam itu dapat digunakan untuk menambahkan fitur ke sekarang; untuk
contoh, lihat /usr/lib/noweb/noxref.krom. sekarang mendukung hingga empat filter; satu
bisa mendapatkan lebih banyak dengan tipu daya shell, misalnya, -Saring "ikon.filter | noidx". itu
-autodef, -x, -indeks, dan -indeksdari opsi diimplementasikan sebagai filter. Filter
dieksekusi dengan shell's evaluasi perintah, jadi cmd harus dikutip sebagaimana mestinya.

-markup pengurai
penggunaan pengurai untuk mengurai file masukan. Memungkinkan penggunaan alat sekarang pada file di lainnya
format; misalnya, markup pengurai mengerti web baru(1) format. Lihat
filter sekarang(7) untuk informasi lebih lanjut. Untuk para ahli saja.

-Pilihan memilih
Menambahkan \nowebopsi{memilih} ke Getah kepala. Lihat gaya sekarang(1) untuk nilai memilih.
Biasanya hanya berguna dengan -getah pilihan, tapi -Pilihan longxref bekerja ilmu hitam
dengan -html.

-menunda Secara default, sekarang menempatkan nama-file dan informasi lainnya ke dalam output sebelum
bagian pertama dari program. -menunda menunda informasi itu sampai setelah yang pertama
potongan dokumentasi, membuat tindakan sedikit seperti WEB `` limbo.'' Pilihannya adalah
biasanya digunakan untuk memungkinkan pengguna menempatkan Getah \kelas dokumen Command
dan materi pembukaan lainnya di bagian dokumentasi pertama (yaitu, sebelum itu
tanda @ pertama). Opsi ini juga memaksa informasi referensi silang yang tertinggal ke
dipancarkan tepat sebelum potongan terakhir, bukan di akhir dokumen; NS
potongan terakhir diharapkan mengandung \end{dokumen}. -menunda pilihan menyiratkan
-n .

-tk Perluas tab dengan perhentian setiap k kolom. (Default adalah untuk memperluas setiap 8 kolom.)

-t Salin tab ke output.

-v Cetak info pipa dan RCS pada kesalahan standar.

MENGINDEKSI DAN REFERENSI SILANG

Saat digunakan dengan Getah, troff, atau HTML, sekarang dapat memberikan pengindeksan dan referensi silang
informasi untuk potongan dan untuk pengidentifikasi bahasa pemrograman. Definisi pengenal
dapat ditandai dengan tangan menggunakan backticks (`); NS -Saring btdefn opsi mengenali ini
tanda. Untuk beberapa bahasa, definisi dapat ditemukan secara otomatis menggunakan -autodef
pilihan. Bagian ini menjelaskan opsi pengindeksan dan referensi silang; mungkin saja
dilewati pada bacaan pertama.

-x Untuk Getah, tambahkan nomor halaman ke setiap nama potongan yang mengidentifikasi lokasi itu
definisi chunk, dan memancarkan informasi referensi silang terkait definisi dan
menggunakan. Untuk HTML, membuat tautan hypertext antara penggunaan dan definisi potongan.
Ketika sekarang -x digunakan dengan Getah, urutan kontrol \sekarang potongan web berkembang menjadi
daftar yang diurutkan dari semua potongan kode.

-indeks Buat informasi referensi silang (atau tautan hypertext) untuk pengidentifikasi yang ditentukan.
Definisi adalah yang ditemukan di file input oleh -autodef bahasa atau dengan
-Saringbtdefn. Memerlukan Getah or HTML. -indeks menyiratkan -X; termasuk keduanya akan
menghasilkan output yang tampak aneh. sekarang tidak menghasilkan referensi silang ke
pengidentifikasi yang muncul dalam kode yang dikutip (@[[...@]]), tetapi menghasilkan hypertext
link. Kapan sekarang -indeks digunakan dengan Getah, urutan kontrol \nowebindex
memperluas ke indeks pengidentifikasi.

-indeksdari indeks
Seperti -indeks, tetapi pengidentifikasi yang akan diindeks diambil dari file indeks. Lihat
noindex(1).

-autodef lang
Temukan definisi pengenal secara otomatis. Kode dalam potongan harus dalam bahasa
lang. Diizinkan langs bervariasi tetapi mungkin termasuk tex or icon. Tidak berguna tanpa -indeks,
yang harus didahului.

-showautodefs
Tunjukkan nilai dari lang dapat digunakan dengan -autodef.

ERROR PESAN

If tidak bersudut or sekarang menemukan nama chunk dalam dokumentasi, diasumsikan bahwa ini
menunjukkan kesalahan, biasanya salah mengeja ``< >=''. Pesan kesalahan lainnya seharusnya
cukup jelas.

Adalah tidak benar untuk merujuk ke suatu potongan yang tidak pernah didefinisikan, tetapi tidak apa-apa jika potongan menjadi
ditentukan dan tidak digunakan.

CONTOH

Jika Anda kesulitan mencerna halaman manual ini, Anda tidak sendirian. Berikut adalah beberapa contoh untuk
membantu Anda memulai. Saya akan menganggap Anda memiliki foo.nw file dengan program C dalam potongan < >
dan file header dalam potongan < >, dan dokumentasi Anda ditandai menggunakan
getah(1). Saya akan menunjukkan cara membangun sesuatu menggunakan opsi paling umum.

Untuk membangun kembali sumber C Anda, coba
tidak bersudut -L -Rfoo.c foo.nw > foo.c
Untuk membangun kembali file header Anda, coba
tidak bersudut -Rfoo.h foo.nw | cpif foo.h
Ada dua kompromi di sini. Menghilangkan -L terus #garis dari file header Anda, dan
menggunakan cpif mencegah perintah dari menulis ulang foo.h kecuali isinya berubah.
Jadi, ini adalah kode yang bagus untuk dimasukkan ke dalam aturan Makefile.

Untuk membuat dokumen tercetak, jalankan
sekarang -autodef c -indeks foo.nw > foo.tex
Jika Anda memiliki pembukaan Anda sendiri, yang berisi \kelas dokumen dan semuanya, Anda juga akan membutuhkan
-menunda .

Untuk membangun halaman web, jalankan
sekarang -Saring l2 jam -autodef c -indeks -html foo.nw | htmltoc > foo.html
Have fun!

Gunakan notangle online menggunakan layanan onworks.net