Ini ialah perintah nountangle yang boleh dijalankan dalam penyedia pengehosan percuma OnWorks menggunakan salah satu daripada berbilang stesen kerja dalam talian percuma kami seperti Ubuntu Online, Fedora Online, emulator dalam talian Windows atau emulator dalam talian MAC OS.
JADUAL:
NAMA
notangle, nowweave, nountangle - noweb, alat pengaturcaraan celik
SINOPSIS
notangle [-Rnama akar ...] [-penapis perintah] [-L[format]] [fail] ...
nountangle [-ml|-m3|-c|-c++|-awk|-tex|-f77|-f90|-bisu|-matlab] [-Rnama akar ...] [-penapis
perintah] [-wlebar] [fail] ...
tidak menenun [pilihan] [fail] ...
DESCRIPTION
Noweb ialah alat pengaturcaraan celik seperti Knuth WEB, hanya lebih ringkas. A noweb fail
mengandungi kod sumber program yang dijalin dengan dokumentasi. Bila notangle diberi a
noweb fail, ia menulis program pada output standard. Bila tidak menenun diberi a noweb fail,
ia berbunyi noweb sumber dan menghasilkan, pada output standard, LaTeX, TeX, troff, Atau HTML
sumber untuk dokumentasi set taip. nountangle menukar program celik kepada program biasa
atur cara dengan menukar dokumentasi bersilang menjadi komen. Nama fail `-' merujuk kepada
input standard.
FORMAT OF NOWEB FILES
A noweb fail ialah urutan daripada ketulan, yang mungkin muncul dalam sebarang susunan. Seketul mungkin mengandungi
kod atau dokumentasi. Potongan dokumentasi bermula dengan garisan yang bermula dengan tanda at
(@) diikuti dengan ruang atau baris baharu. Mereka tidak mempunyai nama. Ketulan kod bermula dengan
<<sekeping nama>> =
pada baris dengan sendirinya. Tanda kurung sudut kiri berganda (<<) mestilah dalam lajur pertama.
Potongan ditamatkan pada permulaan bongkah lain, atau pada akhir fail. Jika yang pertama
baris dalam fail tidak menandakan permulaan ketulan, ia diandaikan sebagai yang pertama
barisan ketulan dokumentasi.
Potongan dokumentasi mengandungi teks yang diabaikan oleh notangle dan disalin kata kerja kepada
keluaran standard oleh tidak menenun (kecuali kod yang dipetik). tidak menenun boleh bekerja dengan LaTeX, kosong
TeX, troff or HTML. Dengan polos TeX, ia memasukkan rujukan kepada a TeX pakej makro, nwmac,
yang mentakrifkan arahan seperti \bab and \bahagian.
Ketulan kod mengandungi kod sumber program dan rujukan kepada ketulan kod lain. Beberapa kod
ketulan mungkin mempunyai nama yang sama; notangle menggabungkan definisi mereka untuk menghasilkan satu
bongkah, sama seperti yang dilakukan memperkacaukan(1). Takrif ketulan kod adalah seperti takrifan makro;
notangle mengekstrak program dengan mengembangkan satu bahagian (secara lalai, bahagian bernama <<*>>).
Takrif bongkah itu mengandungi rujukan kepada ketulan lain, iaitu ketulan itu sendiri
diperluaskan, dan seterusnya. notangleOutput boleh dibaca; ia mengekalkan lekukan daripada
bongkah mengembang berkenaan dengan ketulan di mana ia kelihatan.
Kod boleh dipetik dalam bahagian dokumentasi dengan meletakkan kurungan dua segi empat sama ([[...]])
sekelilingnya. Tanda kurung dua segi empat sama ini diabaikan oleh tidak kusut, tetapi mereka boleh digunakan oleh
tidak menenun untuk memberikan kod rawatan tipografi khas, cth, pautan hiperteks. Jika dipetik
kod berakhir dengan tiga atau lebih kurungan segi empat sama, tidak menenun memilih pasangan yang paling tepat, supaya,
sebagai contoh, [[a[i]]] dihuraikan dengan betul. Nama ketulan kod mungkin muncul di dalamnya
kod petikan melainkan kod petikan itu sendiri adalah sebahagian daripada nama ketulan kod.
Dalam kod, noweb menganggap kurungan dua sudut kiri atau kanan yang tidak berpasangan sebagai literal << and >>.
Untuk memaksa mana-mana kurungan sedemikian, walaupun kurungan berpasangan atau kurungan dalam dokumentasi, menjadi
dianggap sebagai literal, gunakan tanda di hadapan (cth @<).
Sesetengah bahasa pengaturcaraan atau pemformatan mungkin memerlukan satu @ tandatangan di lajur pertama.
Pengguna Noweb boleh mencapai kesan ini dengan meletakkan dua kali ganda @@ dalam lajur pertama; di dalam ini
kedudukan sahaja, ia bermaksud satu @ tanda.
KELIRUTAN
notangle and nountangle menerima set pilihan yang sama, walaupun beberapa pilihan mempunyai kesan
hanya pada satu atau yang lain. Pilihannya ialah:
-Rnama Mengembangkan <<nama>> ketulan kod. The -R pilihan boleh diulang, di mana setiap satu
bongkah ditulis pada output. Jika tidak -R pilihan diberikan, kembangkan bahagian yang dinamakan
<<*>>.
-Lformat
Pancarkan petunjuk nombor baris pada sempadan bongkah. Petunjuk nombor baris
mengenal pasti punca garisan yang mengikutinya. Dalam format, %F menunjukkan
nama fail sumber, %L menunjukkan nombor baris fail sumber, %N
menunjukkan baris baharu, dan %% menunjukkan tanda peratus. Tanda dan angka mungkin
disisipkan di antara tanda peratus dan `L', dalam hal ini nombor baris akan
diselaraskan dengan jumlah tersebut. Jika format ditinggalkan, format lalai ialah itu
diterima oleh prapemproses C: `#garisan %L "%F"%N'. Apabila menggunakan -Lformat pilihan,
notangle memastikan bahawa semua teks muncul dalam lajur yang sama dalam input dan output.
nountangle mengabaikan pilihan ini.
Rentetan format biasa termasuk:
C -L'#line %L "%F"%N'
Matahari FORTRAN -L'\# %L "%F"%N'
Icon -L'#line %-1L "%F"%N'
Modula-3 -L'<*LINE %L "%F" *>%N'
SML/NJ -L'(*#line %L "%F"*)'
Untuk menyelesaikan masalah sebaliknya, iaitu, untuk mendapatkan noweb untuk melakukan sesuatu yang wajar
#garisan dalam inputnya, lihat garis tajam tapis dalam direktori contoh.
-tk Salin tab yang tidak disentuh daripada input ke output, dan gunakan tab untuk lekukan, andaikan
berhenti setiap k lajur. Secara lalai, tab dikembangkan kepada ruang dengan hentian setiap 8
lajur.
-penapis cmd
Tapis noweb sumber melalui cmd selepas menukarnya kepada bentuk alat dan sebelum
kusut. notangle mencari cmd pertama pada pengguna PATH, kemudian masuk /usr/lib/noweb.
Penapis sedemikian boleh digunakan untuk menambah ciri notangle; untuk contoh lihat
/usr/lib/noweb/emptydefn. Untuk pakar sahaja.
-penanda parser
Penggunaan parser untuk menghuraikan fail input. Membolehkan penggunaan alat noweb pada fail lain
format; sebagai contoh, yang numarkup parser faham nuweb(1) format. Lihat
nowebfilters(7) untuk maklumat lanjut. Untuk pakar sahaja.
-awk | -c | -icn | -ikon | -ml | -m3 | -pascal | -f77 | -f90 | -tex
Bila nountangle menukar bahagian dokumentasi menjadi ulasan, gunakan ulasan
format bahasa yang dinamakan. -c adalah lalai. notangle mengabaikan pilihan ini.
-wn Bila nountangle menukar ketulan dokumentasi kepada ulasan, membuat ulasan pada
garisan lebar n. notangle mengabaikan pilihan ini.
MENJAGA
Keluaran dari tidak menenun boleh digunakan dalam TeX dokumen yang \input nwmac, in LaTeX dokumen
yang menggunakan noweb pakej (lihat nowebstyle(1)), dan dalam HTML dokumen untuk dilayari
Mozek(1). Tidak menenun merawat ketulan kod agak suka LaTeX senarai persekitaran. Jika ``@
'' yang menamatkan ketulan kod diikuti dengan serta-merta oleh teks, teks itu mengikuti
ketulan kod tanpa patah perenggan. Jika selebihnya baris kosong, tidak menenun meletakkan TeX
ke dalam ``mod menegak,'' dan teks kemudiannya memulakan perenggan yang baru dan inden.
Tiada pemisah halaman berlaku di tengah-tengah ketulan kod melainkan perlu untuk mengelakkan terlalu penuh
vbox. Bahagian dokumentasi segera sebelum ketulan kod muncul pada halaman yang sama
kerana bahagian kod itu melainkan jika berbuat demikian akan melanggar peraturan sebelumnya.
Tidak menenun tidak memasukkan baris baharu tambahan di dalamnya TeX output, jadi nombor baris diberikan dalam TeX
mesej ralat adalah sama seperti yang terdapat dalam fail input.
tidak menenun mempunyai pilihan yang menentukan pilihan pemformat dan yang menyokong pemformatan yang berbeza
simpulan bahasa dan alat. Pilihan asas diterangkan di sini; pilihan yang berkaitan dengan indeks dan silang
maklumat rujukan diterangkan dalam bahagian INDEKS DAN RUJUKAN MERENTAS.
-lateks Pancarkan LaTeX, termasuk pembungkus masuk artikel gaya dengan noweb pakej dan halaman
gaya. (Lalai)
-tex Pancarkan TeX biasa, termasuk pembalut dengan nwmac makro.
-html Pancarkan HTML, menggunakan pembalut HTML. Outputnya tidak menarik tanpa -indeks or -x.
Tag and , pada talian sendiri, menghasilkan senarai
ketulan dan indeks pengecam, masing-masing. Jika teg ini tidak ada,
senarai dan indeks diletakkan di hujung fail.
-lateks+html
Andaikan ketulan dokumentasi ialah LaTeX, tetapi jana HTML untuk ketulan kod, sesuai
ditandakan jadi penukaran dengan lateks2html(1) menghasilkan keluaran yang munasabah. Pembalut LaTeX
tersirat, tetapi boleh dimatikan dengan -n. Penggunaan of ini pilihan is tidak digunakan; penggunaan
-html bersama -penapis l2j sebaliknya.
-troff Mengeluarkan troff(1) markup (tanpa pembalut). Hasilnya harus diproses dengan
noroff(1). Laporan pepijat untuk -troff kepada Aaron Robbins <[e-mel dilindungi]>.
-n Jangan gunakan sebarang pembalut (pengepala atau treler). Pilihan ini berguna apabila tidak menenun's
output akan menjadi sebahagian daripada dokumen yang lebih besar. Lihat juga -kelewatan.
-penapis cmd
Menapis noweb sumber melalui cmd selepas menukarnya kepada bentuk alat dan sebelum
menukar kepada TeX. tidak menenun mencari cmd pertama pada pengguna JALAN, kemudian masuk
/usr/lib/noweb. Penapis sedemikian boleh digunakan untuk menambah ciri tidak menenun; untuk sebuah
contoh, lihat /usr/lib/noweb/noxref.krom. Tidak menenun menyokong sehingga empat penapis; satu
boleh mendapatkan lebih banyak dengan tipu helah shell, sebagai contoh, -penapis "ikon.penapis | noidx". Yang
-autodef, -x, -indeks, dan -indeks daripada pilihan dilaksanakan sebagai penapis. Penapis
dilaksanakan dengan shell's menipu perintah, jadi cmd hendaklah dipetik sewajarnya.
-penanda parser
Penggunaan parser untuk menghuraikan fail input. Membolehkan penggunaan alat noweb pada fail lain
format; sebagai contoh, yang numarkup parser faham nuweb(1) format. Lihat
nowebfilters(7) untuk maklumat lanjut. Untuk pakar sahaja.
-pilihan pilih
Tambah \noweboptions{pilih} kepada LaTeX kepala. Lihat nowebstyle(1) untuk nilai memilih
Biasanya berguna hanya dengan -lateks pilihan, tetapi -pilihan longxref berfungsi ilmu hitam
bersama -html.
-kelewatan Secara lalai, tidak menenun meletakkan nama fail dan maklumat lain ke dalam output sebelum
bahagian pertama program. -kelewatan menangguhkan maklumat itu sehingga selepas yang pertama
bongkah dokumentasi, membuat tindakan sedikit seperti WEB ``Limbo.'' Pilihannya ialah
biasanya digunakan untuk membolehkan pengguna meletakkan khusus LaTeX \documentclass arahan
dan bahan mukadimah lain dalam bahagian dokumentasi pertama (iaitu, sebelum yang
pertama @ tanda). Pilihan ini juga memaksa mengekori maklumat rujukan silang ke
dipancarkan sejurus sebelum bahagian akhir, bukannya di penghujung dokumen; yang
bongkah akhir dijangka mengandungi \end{document}. . -kelewatan pilihan membayangkan
-n pilihan.
-tk Kembangkan tab dengan setiap hentian k lajur. (Lalai adalah untuk mengembangkan setiap 8 lajur.)
-t Salin tab ke output.
-v Cetak maklumat saluran paip dan RCS pada ralat standard.
MENGINDEKS DAN RUJUKAN TERSEBUT
Apabila digunakan dengan LaTeX, troff, Atau HTML, tidak menenun boleh menyediakan pengindeksan dan rujukan silang
maklumat untuk ketulan dan untuk pengecam bahasa pengaturcaraan. Takrifan pengecam
boleh ditanda dengan tangan menggunakan kutu belakang (`); yang -penapis btdefn pilihan mengenali ini
penandaan. Untuk sesetengah bahasa, definisi boleh didapati secara automatik menggunakan -autodef
pilihan. Bahagian ini menerangkan pilihan pengindeksan dan rujukan silang; boleh jadi
dilangkau pada bacaan pertama.
-x Untuk LaTeX, tambahkan nombor halaman pada setiap nama bahagian yang mengenal pasti lokasi itu
definisi chunk, dan mengeluarkan maklumat rujukan silang yang berkaitan dengan definisi dan
kegunaan. Untuk HTML, cipta pautan hiperteks antara kegunaan dan definisi ketulan.
Bila tidak menenun -x digunakan dengan LaTeX, urutan kawalan \nowebchunks mengembang kepada a
senarai diisih semua ketulan kod.
-indeks Bina maklumat rujukan silang (atau pautan hiperteks) untuk pengecam yang ditentukan.
Definisi ialah yang terdapat dalam fail input oleh -autodef bahasa atau dengan
-penapisbtdefn. Memerlukan LaTeX or HTML -indeks bererti -x; termasuk kedua-dua kehendak
menjana keluaran yang kelihatan pelik. tidak menenun tidak menjana rujukan silang kepada
pengecam yang muncul dalam kod petikan (@[[...@]]), tetapi ia menghasilkan hiperteks
pautan. Bila tidak menenun -indeks digunakan dengan LaTeX, urutan kawalan \nowebindex
berkembang kepada indeks pengecam.
-indeks daripada indeks
suka -indeks, tetapi pengecam yang akan diindeks diambil daripada fail indeks. Lihat
NOINDEX(1).
-autodef lang
Temui definisi pengecam secara automatik. Kod dalam ketulan mestilah dalam bahasa
lang. dibenarkan langs berbeza-beza tetapi mungkin termasuk tex or ikon. Tidak berguna tanpa -indeks,
yang mesti didahulukan.
-showautodefs
Tunjukkan nilai bagi lang boleh digunakan dengan -autodef.
RALAT PESAN
If notangle or tidak menenun menemui nama bahagian dalam dokumentasi, ia menganggap bahawa ini
menunjukkan ralat, biasanya salah ejaan ``< >=''. Mesej ralat lain sepatutnya
penerangan sendiri.
Adalah tidak betul untuk merujuk kepada ketulan yang tidak pernah ditakrifkan, tetapi adalah OK untuk ketulan itu
ditakrifkan dan tidak digunakan.
CONTOH
Jika anda menghadapi masalah mencerna halaman manual ini, anda tidak bersendirian. Berikut adalah beberapa contoh untuk
mulakan anda. Saya akan menganggap anda mempunyai foo.nw fail dengan program C dalam bahagian < >
dan fail pengepala dalam ketulan < >, dan bahawa dokumentasi anda ditandai menggunakan
getah(1). Saya akan menunjukkan kepada anda cara membina sesuatu menggunakan pilihan yang paling biasa.
Untuk membina semula sumber C anda, cuba
notangle -L -Rfoo.c foo.nw > foo.c
Untuk membina semula fail pengepala anda, cuba
notangle -Rfoo.h foo.nw | cpif foo.h
Terdapat dua kompromi di sini. Meninggalkan -L terus #garisan daripada fail pengepala anda, dan
menggunakan cpif menghalang arahan daripada menulis semula foo.h melainkan kandungannya telah berubah.
Oleh itu, ini adalah kod yang baik untuk dimasukkan ke dalam peraturan Makefile.
Untuk membina dokumen bercetak, jalankan
tidak menenun -autodef c -indeks foo.nw > foo.tex
Jika anda mempunyai mukadimah anda sendiri, mengandungi \documentclass dan semua, anda juga akan memerlukan
-kelewatan pilihan.
Untuk membina halaman web, jalankan
tidak menenun -penapis l2j -autodef c -indeks -html foo.nw | htmltoc > foo.html
Bersenang-senang!
Gunakan nountangle dalam talian menggunakan perkhidmatan onworks.net
