docs: Restructure some sources, and localize Japanese header navbar

.github/workflows/build.yml

@@ -768,7 +768,6 @@ jobs:
           meson setup build \
             -Dwith-bdb=/opt/homebrew/opt/berkeley-db \
             -Dwith-init-style=macos-launchd \
-            -Dwith-ssl-dir=/opt/homebrew/opt/libressl \
             -Dbuild-tests=true
       - name: Meson - Build
         run: ninja -C build

NEWS

@@ -17,9 +17,9 @@ Changes in 3.2.0
        afp.conf option "ldap server" has been replaced with "ldap uri"
        and has a new syntax. See the manual for details.
 * NEW: Option to log to file with second (not ms) accuracy, GitHub #580
-       Enable with afp.conf option: "log seconds"
+       Enable with afp.conf option: "log microseconds = no"
 * NEW: Option to add delay to FCE event emission, GitHub #849
-       Enable with afp.conf option: "fce sendwait"
+       Set a ms delay with afp.conf option: "fce sendwait"
 * NEW: afppasswd: Add -w option to set password from the CLI, GitHub #936
 * UPD: BREAKING: Remove legacy cdb and tdb CNID backends, GitHub #508
 * UPD: BREAKING: Remove Andrew File System (AFS) support, GitHub #554

configure.ac

@@ -261,14 +261,14 @@ AC_CONFIG_FILES([
   doc/ja/Makefile
   doc/ja/manual/Makefile
   doc/ja/manual/manual.xml
-  doc/ja/manual/netatalk.html
+  doc/ja/manual/pageheader.txt
   doc/ja/manpages/Makefile
   doc/ja/manpages/man1/Makefile
   doc/ja/manpages/man5/Makefile
   doc/ja/manpages/man8/Makefile
   doc/manual/Makefile
   doc/manual/manual.xml
-  doc/manual/netatalk.html
+  doc/manual/pageheader.txt
   doc/manpages/Makefile
   doc/manpages/man1/Makefile
   doc/manpages/man5/Makefile

doc/manual/generate_compile_docs.py → doc/generate_compile_docs.py

@@ -2,35 +2,39 @@
 
 # This script generates the compile.xml manual page from the GitHub build.yml file.
 
+import datetime
 import re
-import yaml
 import xmltodict
+import yaml
+
+now = datetime.datetime.now()
+date_time = now.strftime("%Y-%m-%d")
 
 lang_en = {
   "title_1": "Compile Netatalk from Source",
   "title_2": "Overview",
   "title_3": "Operating Systems",
   "heading_1": "Install required packages",
   "heading_2": "Configure and build",
-  "para_1": "This section describes how to compile Netatalk from source for specific operating systems.",
-  "para_2": "Please note that this chapter is automatically generated and may not be optimized for your system.",
-  "para_3": "Choose either Autotools or Meson as the build system. Test steps are optional.",
+  "para_1": "This appendix describes how to compile Netatalk from source for specific operating systems.",
+  "para_2": "Please note that the steps below are automatically generated, and may not be optimized for your system.",
+  "para_3": "Choose one of the build systems: Autotools or Meson. Test steps are optional.",
 }
 lang_jp = {
   "title_1": "Netatalk をソースコードからコンパイルする",
   "title_2": "概要",
   "title_3": "オペレーティング システム一覧",
   "heading_1": "必要なパッケージをインストールする",
   "heading_2": "コンフィグレーションとビルド",
-  "para_1": "本付録では、特定のオペレーティング システムのソースから Netatalk をコンパイルする方法について説明する。",
-  "para_2": "以下文章は自動的に生成されるため、お使いのシステムに最適化されていない可能性があることに注意してください。",
-  "para_3": "ビルド システムとして Autotools と Meson から選択する。 テスト手順は任意である。",
+  "para_1": "本付録では、以下オペレーティング システムで Netatalk のソースコードをコンパイルする手順が記載されている。",
+  "para_2": "本手順書は自動的に生成されたため、ご使用のシステムに最適化されていない可能性があるのでご了承ください。",
+  "para_3": "Autotools か Meson のビルドシステムは選択可能。 テスト手順は任意である。",
 }
 
-output_en = "compile.xml"
-output_jp = "../ja/manual/compile.xml"
+output_en = "./manual/compile.xml"
+output_jp = "./ja/manual/compile.xml"
 
-with open('../../.github/workflows/build.yml', 'r') as file:
+with open('../.github/workflows/build.yml', 'r') as file:
   workflow = yaml.safe_load(file)
 
 apt_packages_pattern = r'\$\{\{\senv\.APT_PACKAGES\s\}\}'
@@ -40,6 +44,11 @@ def generate_docbook(strings, output_file):
   docbook = {
     "appendix": {
       "@id": "compile",
+      "appendixinfo": [
+        {
+          "pubdate": date_time
+        },
+      ],
       "title": strings["title_1"],
       "sect1": [
         {
@@ -50,16 +59,14 @@ def generate_docbook(strings, output_file):
           "para": [
             strings["para_1"],
             strings["para_2"],
+            strings["para_3"],
           ],
         },
         {
           "@id": "compile-os",
           "title": strings["title_3"],
         },
         {
-          "para": [
-            strings["para_3"],
-          ],
           "sect2": [],
         }
       ],

doc/html.xsl.in

@@ -9,7 +9,7 @@
 	<xsl:param name="toc.max.depth" select="2"/>
 
 	<xsl:template name="user.header.navigation">
-		<xsl:variable name="codefile" select="document('netatalk.html',/)"/>
+		<xsl:variable name="codefile" select="document('pageheader.txt',/)"/>
 		<xsl:copy-of select="$codefile/*/node()"/>
 	</xsl:template>
 </xsl:stylesheet>

doc/ja/html.xsl.in

@@ -10,7 +10,7 @@
 	<xsl:param name="toc.max.depth" select="2"/>
 
 	<xsl:template name="user.header.navigation">
-		<xsl:variable name="codefile" select="document('netatalk.html',/)"/>
+		<xsl:variable name="codefile" select="document('pageheader.txt',/)"/>
 		<xsl:copy-of select="$codefile/*/node()"/>
 	</xsl:template>
 </xsl:stylesheet>

doc/ja/manpages/man5/afp.conf.5.xml

@@ -5,7 +5,7 @@
 
     <manvolnum>5</manvolnum>
 
-    <refmiscinfo class="date">15 May 2024</refmiscinfo>
+    <refmiscinfo class="date">31 May 2024</refmiscinfo>
 
     <refmiscinfo class="source">Netatalk</refmiscinfo>
 
@@ -32,8 +32,7 @@
   <refsect1 id="FILEFORMATSECT">
     <title>ファイルの書式</title>
 
-    <para>ファイルはセクションとパラメータから構成される。セクションはブラケット[各括弧]で囲まれたセクション名に始まり、次のセクションが始まるまで続く。セクションには次のような書式のパラメータが含まれている:
-    <programlisting>
+    <para>ファイルはセクションとパラメータから構成される。セクションはブラケット[各括弧]で囲まれたセクション名に始まり、次のセクションが始まるまで続く。セクションには次のような書式のパラメータが含まれている:<programlisting>
     <replaceable>name</replaceable> = <replaceable>value </replaceable>
     </programlisting></para>
 
@@ -904,7 +903,8 @@
         </varlistentry>
 
         <varlistentry>
-          <term>signature = &lt;text&gt; <type>(G)</type></term>
+          <term>signature = <replaceable>STRING</replaceable>
+          <type>(G)</type></term>
 
           <listitem>
             <para>サーバシグネチャを指定する。最大長は16文字である。このオプションは障害隔離などを提供するクラスタ環境において有用である。デフォルトでは、afpdは自動的にシグネチャを(乱数を元に)生成し、それを<filename>afp_signature.conf</filename>に保存する。asip-status(1)も見よ。</para>
@@ -1055,7 +1055,7 @@
           <type>(G)</type></term>
 
           <listitem>
-            <para>指定しない場合、Netatalkはsyslogデーモン機能にログを出力する。そうでない場合は<option>logfile</option>に出力する。</para>
+            <para>ログを<option>logfile</option>に出力する。指定しない場合、Netatalkはsyslogデーモン機能にログを出力する。</para>
           </listitem>
         </varlistentry>
 
@@ -1082,6 +1082,16 @@
             </note>
           </listitem>
         </varlistentry>
+
+        <varlistentry>
+          <term>log microseconds = <replaceable>BOOLEAN</replaceable> (デフォルト:
+          <emphasis>yes</emphasis>) <type>(G)</type></term>
+
+          <listitem>
+            <para>タイムスタンプをマイクロ秒単位の精度でログに記録する。無効にすると、タイムスタンプは秒単位のみを記録する。<option>log
+            file</option> オプションと組み合わせて使用​​した場合にのみ有効になる。</para>
+          </listitem>
+        </varlistentry>
       </variablelist>
     </refsect2>
 
@@ -1187,7 +1197,7 @@
         </varlistentry>
 
         <varlistentry>
-          <term>fce sendwait = <replaceable>ミリ秒</replaceable>
+          <term>fce sendwait = <replaceable>milliseconds</replaceable>
           <type>(G)</type></term>
 
           <listitem>

doc/ja/manual/.gitignore

@@ -1,2 +1,3 @@
 manual.xml
+pageheader.txt
 *.html

doc/ja/manual/Makefile.am

@@ -17,7 +17,7 @@ EXTRA_DIST = \
 	install.xml \
 	intro.xml \
 	manual.xml.in \
-	netatalk.html.in \
+	pageheader.txt.in \
 	upgrade.xml
 
 HTML_PAGES = \
@@ -49,7 +49,7 @@ HTML_PAGES = \
 	table-toc.html \
 	upgrade.html
 
-DISTCLEANFILES = manual.xml natatalk.html
+DISTCLEANFILES = manual.xml pageheader.txt
 
 if HAVE_XSLTPROC
 CLEANFILES += $(HTML_PAGES)

doc/ja/manual/compile.xml

@@ -1,18 +1,21 @@
 <?xml version="1.0" encoding="utf-8"?>
 <appendix id="compile">
+	<appendixinfo>
+		<pubdate>2024-05-31</pubdate>
+	</appendixinfo>
 	<title>Netatalk をソースコードからコンパイルする</title>
 	<sect1 id="compile-overview">
 		<title>概要</title>
 	</sect1>
 	<sect1>
-		<para>本付録では、特定のオペレーティング システムのソースから Netatalk をコンパイルする方法について説明する。</para>
-		<para>以下文章は自動的に生成されるため、お使いのシステムに最適化されていない可能性があることに注意してください。</para>
+		<para>本付録では、以下オペレーティング システムで Netatalk のソースコードをコンパイルする手順が記載されている。</para>
+		<para>本手順書は自動的に生成されたため、ご使用のシステムに最適化されていない可能性があるのでご了承ください。</para>
+		<para>Autotools か Meson のビルドシステムは選択可能。 テスト手順は任意である。</para>
 	</sect1>
 	<sect1 id="compile-os">
 		<title>オペレーティング システム一覧</title>
 	</sect1>
 	<sect1>
-		<para>ビルド システムとして Autotools と Meson から選択する。 テスト手順は任意である。</para>
 		<sect2 id="build-alpine">
 			<title>Alpine Linux</title>
 			<para>Install dependencies</para>
@@ -884,7 +887,6 @@ ninja -C build uninstall
 				<screen>meson setup build \
   -Dwith-bdb=/opt/homebrew/opt/berkeley-db \
   -Dwith-init-style=macos-launchd \
-  -Dwith-ssl-dir=/opt/homebrew/opt/libressl \
   -Dbuild-tests=true
 </screen>
 			</para>

doc/ja/manual/meson.build

@@ -4,9 +4,9 @@ manual_xml = configure_file(
     configuration: cdata,
 )
 
-netatalk_html = configure_file(
-    input: 'netatalk.html.in',
-    output: 'netatalk.html',
+pageheader = configure_file(
+    input: 'pageheader.txt.in',
+    output: 'pageheader.txt',
     configuration: cdata,
 )
 

doc/ja/manual/pageheader.txt.in

@@ -0,0 +1,15 @@
+<html>
+    <div id="header">
+        <div id="logo"></div>
+        <div id="menlinks">
+          <a href="/" title="Netatalk ホームに戻る">[main]</a>
+          <a href="/docs" title="Netatalk Wiki">[wiki]</a>
+          <a href="/documentation.html" title="Netatalk マニュアル">[documentation]</a>
+          <a href="/download.html" title="Netatalk をダウンロード">[downloads]</a>
+          <a href="/support.html" title="お問い合わせ">[support]</a>
+          <a href="/links.html" title="Netatalk 関連リンク">[links]</a>
+          <img src="/gfx/end.gif" alt="" width="125" height="7" />
+        </div>
+    </div>
+    <div class="navheader" align="center">Netatalk @NETATALK_VERSION@</div>
+</html>