texdoc

TEXDOC - Temukan dan Lihat Dokumentasi di Tex Live

Informasi umum

• Situs web: https://www.tug.org/texdoc/
• Repositori: https://github.com/tex-live/texdoc/
• Mailing List: [email protected]

Menggunakan Texdoc

Texdoc adalah bagian dari distribusi langsung TEX. Secara umum, Anda tidak perlu menginstalnya sendiri.

Jika Anda ingin mencoba/menguji versi Kembangkan, silakan lihat di bawah.

Cara menginstal versi kembangkan

Menggunakan bundler

Cara termudah untuk menginstal versi pengembangan TEXDOC adalah menggunakan Bundler dan Rake:

bundle install
rake install

Jika Anda ingin menghapus instalan versi Kembangkan (untuk menggunakan versi Tex Live), coba saja:

rake uninstall

Menginstal secara manual

Di sini, $TEXDOC berarti jalur ke sumber-sumber Dev Texdoc yang Anda kloning (atau diunduh), dan $TEXMFHOME menunjukkan pohon texmf pribadi Anda (Anda bisa mendapatkan lokasinya dengan kpsewhich --var-value TEXMFHOME ).

• Perintah. Symlink atau Salin $TEXDOC/script AS $TEXMFHOME/scripts/texdoc .
• File konfigurasi. Symlink atau Salin $TEXDOC/texdoc.cnf AS $TEXMFHOME/texdoc/texdoc-dist.cnf (Perhatikan bagian -dist ). Ini benar -benar akan mengganti file konfigurasi lainnya kecuali $TEXMFHOME/texdoc/texdoc.cnf yang masih dapat Anda gunakan untuk pengaturan pribadi Anda.

Anda dapat memastikan bahwa file yang tepat digunakan dengan menjalankan texdoc --files : Baris pertama berisi jalur lengkap ke versi bekas texdoclib.tlu , dan sisanya mencantumkan file konfigurasi yang digunakan.

File di repositori ini

• doc/ berisi dokumentasi,
• script/ berisi kode sumber,
• spec/ adalah direktori untuk menguji skrip, dan
• texdoc.cnf adalah file konfigurasi default.

Membangun dan menguji

Banyak tugas bangunan didefinisikan sebagai tugas menyapu.

Menghasilkan semua dokumentasi

Berikut ini akan menghasilkan PDF dan surga di doc/ Direktori.

rake doc

Menghasilkan file cache yang telah diburu

Berikut ini akan menghasilkan script/Data.tlpdb.lua . Tugas ini harus dilakukan di bawah pengaturan TEX Live dengan TLPDB.

rake gen_datafile

Menjalankan tes

Berikut ini akan menjalankan semua tes di spec/ Direktori.

rake test

Atau, Anda dapat memberikan nama spesifikasi dengan opsi --list ( -l ) untuk tugas ini. Misalnya, berikut hanya akan menjalankan spec/action/help_spec.rb dan spec/mode/list_spec.rb :

rake test -- -l action/help,mode/list

Menampilkan semua tugas yang tersedia

Berikut ini akan menampilkan semua tugas yang tersedia dengan deskripsi singkat.

rake -T

Selain itu, untuk opsi tugas yang tersedia, misalnya, rake test dan rake run_texdoc , Anda bisa mendapatkan informasi opsi dengan opsi -h opsi untuk setiap tugas:

rake test -- -h

Informasi lebih lanjut

Informasi yang lebih spesifik, seperti daftar TODO dari proyek ini dan beberapa informasi untuk distributor, dapat ditemukan di wiki repositori GitHub kami. Silakan kunjungi:

• https://github.com/tex-live/texdoc/wiki

Hak Cipta dan Lisensi

Hak Cipta 2008-2024 Manuel Pégourié-Gonnard, Takuto Asakura, tim Tex Live.

Paket ini didistribusikan berdasarkan ketentuan Lisensi Publik Umum GNU seperti yang diterbitkan oleh Free Software Foundation, baik versi 3 lisensi, atau (di opsi Anda) versi selanjutnya.

Pekerjaan sebelumnya (program TEXDOC) di domain publik:

• Kontribusi dari Reinhard Kotucha (2008).
• Versi Texlua Pertama oleh Frank Küster (2007).
• Script Shell Asli oleh Thomas Esser, David Aspinall, dan Simon Wilkinson.