gendocs.sh
gendocs.sh
這個腳本簡化了為您的網頁章節產生 Texinfo 文件輸出的任務,如上所述。它有一個配套的範本檔案,作為 HTML 索引頁面的基礎。兩者都可從 Gnulib 開發取得
https://git.savannah.gnu.org/cgit/gnulib.git/tree/build-aux/gendocs.sh https://git.savannah.gnu.org/cgit/gnulib.git/tree/doc/gendocs_template
還有一個極簡的範本,可從以下位置取得
在包含 Texinfo 原始碼的目錄中,像這樣呼叫此腳本
gendocs.sh --email yourbuglist yourmanual "GNU yourmanual manual"
其中 yourmanual 是您的套件簡短名稱,而 yourbuglist 是錯誤報告的電子郵件地址 (應為 bug-package@gnu.org
)。此腳本會處理 yourmanual.texinfo (或 .texi 或 .txi) 檔案。例如
cd .../texinfo/doc # download gendocs.sh and gendocs_template gendocs.sh --email bug-texinfo@gnu.org texinfo "GNU Texinfo manual"
gendocs.sh
會建立一個子目錄 manual/,其中包含以所有標準輸出格式 (Info、HTML、DVI 等) 產生的手冊,以及 Texinfo 原始碼。然後您需要將所有這些檔案 (保留子目錄) 移動到您套件的網頁中。
您可以指定選項 -o outdir 來覆寫名稱 manual。 outdir 任何先前的內容都將被刪除。
第二個引數,帶有描述,會被包含在整體 manual/index.html 檔案的 HTML <title>
中。它應包含被記錄的套件名稱,如所示。 manual/index.html 是透過從 gendocs_template 檔案替換而建立的。(您可以隨意修改通用範本以符合您的用途。)
如果您有多個手冊,您需要使用不同的引數多次執行此腳本,每次都使用 -o 指定不同的輸出目錄,並將所有輸出移動到您的網頁。然後(手動)編寫一個整體 index.html,其中包含所有手冊的連結。例如
cd .../texinfo/doc gendocs.sh --email bug-texinfo@gnu.org -o texinfo texinfo "GNU Texinfo manual" gendocs.sh --email bug-texinfo@gnu.org -o info info "GNU Info manual" gendocs.sh --email bug-texinfo@gnu.org -o info-stnd info-stnd "GNU info-stnd manual"
預設情況下,此腳本使用 makeinfo
來產生 HTML 輸出。如果您偏好使用 texi2html
,請使用 --texi2html 命令列選項,例如
gendocs --texi2html -o texinfo texinfo "GNU Texinfo manual"
範本檔案將自動產生由 texi2html
產生的額外 HTML 輸出的條目(即,按章節和分節分割)。
您可以設定環境變數 MAKEINFO
、TEXI2DVI
等,來控制執行的程式,並設定 GENDOCS_TEMPLATE_DIR
來控制 gendocs_template 檔案的尋找位置。
像往常一樣,執行 ‘gendocs.sh --help’ 以取得所有選項、環境變數和更多資訊的描述。
請將關於 gendocs
的錯誤報告、增強請求或其他信件以電子郵件寄至 bug-texinfo@gnu.org。