From ad3dded79b0e6feb9fbb6a04ff3e613a51f3a076 Mon Sep 17 00:00:00 2001 From: Daniel Markstedt Date: Sat, 7 Dec 2024 10:57:39 +0100 Subject: [PATCH] docs: Document that DocBook XSL has to be non-namespaced, GitHub #1800 --- INSTALL.md | 7 +++++-- doc/ja/manual/install.xml | 30 +++++++++++++++++++----------- doc/manual/install.xml | 27 ++++++++++++++++++--------- 3 files changed, 42 insertions(+), 22 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index ead00ce4b20..e823c60c826 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -83,6 +83,7 @@ Required: Required for Spotlight support: + - D-Bus (also used by avahi and afpstats) - talloc - tracker version 0.12 or later, or tinysparql and localsearch version 3.8.0 or later - bison @@ -91,9 +92,10 @@ Required for Spotlight support: Optional: - avahi or mDNSresponder (for Zeroconf support) + - cmark-gfm (for converting Markdown to plain text) - cracklib and cracklib dictionary (for password strength check in afppasswd) - - Docbook XSL and xsltproc (for manpages & manual documentation) - - GLib 2 and D-Bus (for afpstats support) + - Docbook XSL, non-namespaced (for manpages & manual documentation) + - GLib 2 and GIO (for afpstats support) - Kerberos V (for krbV UAM support) - libacl (for ACL support) - libldap (for LDAP support) @@ -102,6 +104,7 @@ Optional: - Perl (for admin scripts) - tcpwrap (for TCP wrapper support) - [UnicodeData.txt](https://www.unicode.org/Public/UNIDATA/UnicodeData.txt) (for regenerating Unicode lookup tables) + - xsltproc or libxslt (for manpages & manual documentation) More details about dependencies can be found in the documentation at https://netatalk.io/stable/htmldocs/installation diff --git a/doc/ja/manual/install.xml b/doc/ja/manual/install.xml index f2bc9c01182..5d38d620270 100644 --- a/doc/ja/manual/install.xml +++ b/doc/ja/manual/install.xml @@ -29,11 +29,10 @@ Netatalk のバイナリーパッケージは、いくつかの Linux、BSD、Solaris ディストリビューションに含まれている。通常の配布元も見たいだろうと思う。 - 第三者が提供しているパッケージ リポジトリも参照する手もある。例えば、Red Hat 派生 Linux - ディストリビューションの為の rpmfind、 - Solaris 系 OS の為の OpenCSW、そして macOS の為の Homebrew か 第三者が提供しているパッケージ リポジトリも参照する手もある。例えば、Red Hat 派生 Linux ディストリビューションの為の + rpmfind、 Solaris 系 OS の為の + OpenCSW、そして macOS の為の + Homebrew か MacPorts。 @@ -154,7 +153,15 @@ Resolving deltas: 100% (32227/32227), done. Netatalk は、Avahi または mDNSResponder を使用して AFP ファイル共有と Time Machine ボリュームをアドバタイズできる。 - Avahi を使用する場合は、D-Bus または D-Bus サポートを有効になっている Avahi ライブラリは必要になる。 + Avahi を使用する場合は、D-Bus または D-Bus サポートを有効になっている Avahi + ライブラリは必要になる。 + + + + cmark-gfm + + CommonMark は、マークダウンをプレーンテキストに変換するために使用され、Netatalk の README + をインストールまたはパッケージ化するのに使われる。 @@ -178,9 +185,10 @@ Resolving deltas: 100% (32227/32227), done. DocBook XSL および xsltproc - このマニュアルを含む Netatalk ドキュメントは、XML 形式で作成されている。次に、DocBook XSL + このマニュアルを含む Netatalk ドキュメントは、XML 形式で作成されている。DocBook XSL スタイルシートと xsltproc を使用して、XML を troff (マニュアル ページ用)、html、pdf - などの人間が読める形式に変換する。 + などの人間が読める形式に変換する。DocBook XSL + スタイルシートは名前空間化されていない必要があることに注意してください。 @@ -232,9 +240,9 @@ Resolving deltas: 100% (32227/32227), done. Perl - Netatalk の管理ユーティリティ スクリプトは、Perl ランタイム バージョン 5.8 - 以降に依存する。必須 Perl モジュールは以下： IO::Socket::IP - (asip-status) 又は Net::DBus (afpstats)。 + Netatalk の管理ユーティリティ スクリプトは、Perl ランタイム バージョン 5.8 以降に依存する。必須 + Perl モジュールは以下： IO::Socket::IP (asip-status) + 又は Net::DBus (afpstats)。 diff --git a/doc/manual/install.xml b/doc/manual/install.xml index 9260da78505..adab272da9f 100644 --- a/doc/manual/install.xml +++ b/doc/manual/install.xml @@ -168,6 +168,14 @@ Resolving deltas: 100% (32227/32227), done. library must have been built with D-Bus support. + + cmark-gfm + + CommonMark is used to translate markdown to plain text, + which is useful for installing or packaging Netatalk's + READMEs. + + CrackLib @@ -192,16 +200,17 @@ Resolving deltas: 100% (32227/32227), done. DocBook XSL and xsltproc The Netatalk documentation, including this manual, are - authored in XML format. Then DocBook XSL stylesheets and xsltproc - are used to transcode the XML to other human-readable formats - such as troff (for man pages), html, or pdf. + authored in XML format. DocBook XSL stylesheets and xsltproc are + used to transcode the XML to other human-readable formats such as + troff (for man pages), html, or pdf. Note that the DocBook XSL + stylesheets have to be non-namespaced. GLib and GIO - Used by the afpstats tool to interface - with D-Bus. + Used by the afpstats tool to + interface with D-Bus. @@ -252,10 +261,10 @@ Resolving deltas: 100% (32227/32227), done. Perl - Netatalk's administrative utility scripts rely - on the Perl runtime, version 5.8 or later. The required Perl - modules include IO::Socket::IP (asip-status) - and Net::DBus (afpstats). + Netatalk's administrative utility scripts rely on the Perl + runtime, version 5.8 or later. The required Perl modules include + IO::Socket::IP (asip-status) and + Net::DBus (afpstats).