]> Nishi Git Mirror - dataworks.git/commitdiff
adding japanese document
authornishi <nishi@d4a5a174-5a4a-5b4b-b672-37683c10d7d5>
Thu, 27 Jun 2024 02:36:38 +0000 (02:36 +0000)
committernishi <nishi@d4a5a174-5a4a-5b4b-b672-37683c10d7d5>
Thu, 27 Jun 2024 02:36:38 +0000 (02:36 +0000)
git-svn-id: file:///raid/svn-main/nishi-dataworks/trunk@443 d4a5a174-5a4a-5b4b-b672-37683c10d7d5

.github/workflows/deploy.yml
Document/FORMATv1.md
Document/FORMATv1JP.md
Document/index.tmpl.md
Document/indexjp.tmpl.md
Makefiles/common.mk

index 323516f093cb6a6de2c2f655736415330ff65f87..239c8e15b5d35061e682d2ed1dc3b426440495ac 100644 (file)
@@ -29,13 +29,25 @@ jobs:
       uses: actions/checkout@v4
     - name: Install packages
       run: sudo apt-get install doxygen graphviz
+    - name: Setup directories
+      run: mkdir -p pages/en && mkdir -p pages/jp
+    - name: Clean
+      run: make clean
     - name: Make
       run: make ./Document
+    - name: Copy files
+      run: cp -rf Document/doc/html/* pages/en/
+    - name: Clean
+      run: make clean
+    - name: Make
+      run: make ./Document DOCTARGET=document-jp
+    - name: Copy files
+      run: cp -rf Document/doc/htmljp/* pages/jp/
     - name: Setup Pages
       uses: actions/configure-pages@v4
     - name: Upload pages
       uses: actions/upload-pages-artifact@v3
       with:
-        path: "Document/doc/html"
+        path: "pages"
     - name: Deploy
       uses: actions/deploy-pages@v4
index a8b0124a5016f658cf706305e877fc5faa8c450a..3acd4a7277878cdfdf0fc8778abbb56973c61793 100644 (file)
@@ -10,7 +10,7 @@ All numbers MUST use big-endian.
 
 ### File structure
 
-First 3 bytes MUST be 7F 44 57 (\x7F DW) (`signature`)
+First 3 bytes MUST be `7F 44 57` (`\x7F DW`) (`signature`)
 
 Database entry (`dbentry`) MUST be in this format:
 
index a8b0124a5016f658cf706305e877fc5faa8c450a..7e99f94db481442d63f89912abd2cfe5537c29e1 100644 (file)
@@ -1,54 +1,54 @@
 # DWF - DataWorks Database Format 1.0 {#FORMATv1}
 
-DWF is a simple database format designed for DataWorks.
+DWFはDataWorks用に作られたシンプルなデータベースフォーマットです。
 
-## Specification
+## 指定
 
-You SHOULD use `.dwf` for the extension.
+`.dwf`を拡張子として使うべきです。 (SHOULD)
 
-All numbers MUST use big-endian.
+すべての数値はビッグエンディアンである必要があります。 (MUST)
 
-### File structure
+### ファイルの構造
 
-First 3 bytes MUST be 7F 44 57 (\x7F DW) (`signature`)
+最初の3バイトは`7F 44 57` (`\x7F DW`)である必要があります。 (MUST、文書内では`signature`と呼びます)
 
-Database entry (`dbentry`) MUST be in this format:
+データベースのエントリー(文書内では`dbentry`と呼びます)はこのフォーマットである必要があります: (MUST)
 
-| Name | Size | Type | Info |
+| 名称 | サイズ | 型 | 補足 |
 | ---- | ---- | ---- | ---- |
-| flag | 1 byte | uint8\_t | |
-| length | 8 bytes | uint64\_t | Size of the actual data inside |
-| size | 8 bytes | uint64\_t | |
-| field\_index | 1 byte | uint8\_t | |
-| db\_index | 1 byte | uint8\_t | |
-| count | 8 bytes | uint64\_t | |
-| fragnum | 8 bytes | uint64\_t | |
-| data | \[size\] bytes | Binary | |
+| flag | 1バイト | uint8\_t | |
+| length | 8バイト | uint64\_t | 実データのサイズです。`dbentry`が再利用された際にここが`size`と異なる場合があります。 |
+| size | 8バイト | uint64\_t | |
+| field\_index | 1バイト| uint8\_t | |
+| db\_index | 1バイト | uint8\_t | |
+| count | 8バイト | uint64\_t | |
+| fragnum | 8バイト | uint64\_t | |
+| data | sizeバイト | Binary | |
 
-and 2 flags for `dbentry`:
-| Type | Mask | Info |
+そして2つのフラグが`dbentry`用に定義されています:
+| タイプ | マスク | 補足 |
 | ---- | ---- | ---- |
-| Used | 0b10000000 | Flag this if you are using the entry. |
-| Fragment | 0b01000000 | Flag this if the entry is fragment. |
-| Unset | 0b00100000 | Flag this if the entry is unset. |
+| 使用中 | 0b10000000 | エントリーを使っている時にフラグしてください。 |
+| 断片 | 0b01000000 | エントリーが断片な時にフラグしてください。 |
+| 未設定 | 0b00100000 | 非推奨です。エントリーをダミーとしてとりあえず使う時にフラグされるはずでした。(現在では別のハンドル方法を用いるため、使う必要はありませんし、使わないでください。) |
 
-Index entry (`indexentry`) MUST be in this format:
-| Name | Size | Type | Info |
+インデックスエントリー(文書内では`indexentry`と呼びます)はこのフォーマットである必要があります: (MUST)
+| 名称 | サイズ | 型 | 補足 |
 | ---- | ---- | ---- | ---- |
-| flag | 1 byte | uint8\_t | |
-| count | 8 bytes | uint64\_t | |
-| dbname\_len | 1 byte | uint8\_t | |
-| dbname | 256 bytes | ASCII | |
-| fields | 4096 bytes | ASCII | Separate field names using NUL. Put NUL twice on the last field name. Like: `type` `name` `<NUL>` `type` `name` `<NUL>` ... `type` `name` `<NUL>` `<NUL>` |
+| flag | 1バイト | uint8\_t | |
+| count | 8バイト | uint64\_t | |
+| dbname\_len | 1バイト | uint8\_t | |
+| dbname | 256バイト | ASCII | |
+| fields | 4096バイト | ASCII | フィールド名をNULで区切ってください。最後のフィールド名には1つの代わりに2つNULを入れてください。このように: `type` `name` `<NUL>` `type` `name` `<NUL>` ... `type` `name` `<NUL>` `<NUL>` |
 
-There are 5 types for `indexentry`:
-| Type | Character | Type | Info |
+そして5つの型が`indexentry`用に定義されています:
+| 名称 | 文字 | 型 | 補足 |
 | ---- | --------- | ---- | ---- |
-| String | `S` | ASCII | |
-| Integer | `I` | int64\_t | |
-| Floating | `F` | double | |
-| Logical | `L` | uint8\_t | 0 for false, other value for true |
-| Help | `?` | ASCII | Should be just ignored |
+| 文字列 | `S` | ASCII | |
+| 整数 | `I` | int64\_t | |
+| 浮動小数点 | `F` | double | |
+| 論理 | `L` | uint8\_t | 0なら偽、それ以外なら真と判別してください。 (MUST) |
+| ヘルプ | `?` | ASCII | 無視されるべきです。 (SHOULD) |
 
 There is 1 flag for `indexentry`:
 | Type | Mask | Info |
index c0801a72e49ac0a68edfd5ced3ce30a1e1480241..890f500c9de5d68d6eab1a4fc36572ef4a09dc65 100644 (file)
@@ -1,12 +1,12 @@
 # Abstract {#mainpage}
 
-**DataWorks** is a general-purpose and platform independent database library/client.
+**DataWorks** is a general-purpose and platform independent database library/tools.
 
 This document was generated for DataWorks @VERSION@.
 
 ## License
 
-**DataWorks** is free software, and sources are published under 3-clause BSD License by Crabware/pnsk-lab.
+**DataWorks** is free software, and sources are published under 3-clause BSD License by Crabware/[pnsk-lab](https://github.com/pnsk-lab).
 
 Crabware is a software-development division of Hinode Gakuen PC-Club. Contact: Nishi &lt;nishi@nishi.boats&gt;
 
index c0801a72e49ac0a68edfd5ced3ce30a1e1480241..2d99d0ce14f08f9417d2c74bbf81d1382471764b 100644 (file)
@@ -1,14 +1,14 @@
-# Abstract {#mainpage}
+# 概要 {#mainpage}
 
-**DataWorks** is a general-purpose and platform independent database library/client.
+**DataWorks** は普通な用途に使えるプラットフォーム非依存なデータベースライブラリ/ツールです。
 
-This document was generated for DataWorks @VERSION@.
+このドキュメントはDataWorks @VERSION@用に生成されました。
 
-## License
+## ライセンス
 
-**DataWorks** is free software, and sources are published under 3-clause BSD License by Crabware/pnsk-lab.
+**DataWorks** はフリーソフトウェアであり、ソースコードは3条項ライセンスの下でCrabware/[pnsk-lab](https://github.com/pnsk-lab)によって公開されています。
 
-Crabware is a software-development division of Hinode Gakuen PC-Club. Contact: Nishi &lt;nishi@nishi.boats&gt;
+Crabwareは日出学園パソコン部のソフトウェア開発部門です。 連絡先: Nishi &lt;nishi@nishi.boats&gt;
 
 @example client.c
 @example server.c
index c616e4a0136318e7113dbfe4a387757b639bdcc5..aca0d6bde0a41eecaf3ee01ad8dbd7c3cddeb8d0 100644 (file)
@@ -38,7 +38,7 @@ thanks-banner:
        $(MAKE) -C $@ $(COMPILE_FLAGS) $(TARGET)
 
 ./Document:: ./Tool
-       $(MAKE) -C $@ $(COMPILE_FLAGS) $(TARGET)
+       $(MAKE) -C $@ $(COMPILE_FLAGS) $(TARGET) $(DOCTARGET)
 
 FILES = `find . -name "*.c" -or -name "*.h"`