リポジトリ追記

css/custom.css

@@ -157,6 +157,12 @@
     padding-top: 0.5em;
   }
 
+  .BackCover .Colophon .License {
+    font-size: 8pt;
+    line-height: 1.2;
+    font-weight: normal;
+  }
+
   /* ブックマーク */
   .markdown-body h1 {
     bookmark-level: 1;

css/fix.css

@@ -0,0 +1,30 @@
+/* flow_imgの中のimg要素に高さ指定を追加 */
+.flow_img img {
+    height: 160mm;
+    margin: 0 auto;
+}
+
+/* スクショimg要素を中央揃え横並びで表示させる*/
+.ss_img {
+    display: flex;
+    justify-content: center;
+    align-items: center;
+    flex-wrap: wrap;
+    margin: 0 auto;
+    width: 100%;
+    max-width: 100%;
+    padding: 0;
+    list-style: none;
+    text-align: center;
+    margin-top: 10px;
+    margin-bottom: 10px;
+}
+.ss_img img {
+    height: 100mm;
+    margin: 0 auto;
+}
+
+/* Page Break */
+.page-break {
+    page-break-after: always;
+}

documents/combine_test.md

@@ -1,3 +0,0 @@
-# Combine_Test
-
-## テスト

documents/files.txt

@@ -1,2 +1,18 @@
-main.md
-combine_test.md
+flow/main.md
+flow/scan.md
+flow/viewer.md
+flow/viewer_combined.md
+home/index.md
+library/index.md
+settings/index.md
+settings/tag_manage.md
+viewer/index.md
+viewer/rename.md
+viewer/update.md
+viewer/menu.md
+viewer/tag.md
+viewer/rev.md
+viewer_combined/index.md
+viewer_combined/rename.md
+viewer_combined/menu.md
+viewer_combined/rev.md

documents/flow/main.md

@@ -0,0 +1,17 @@
+# フロー図
+## メインフロー
+
+<div class="flow_img">
+
+![メインフロー](/documents/img/flow/main_flow.png)
+
+</div>
+
+
+1. 右下のFABをタップしてスキャンフローに推移
+2. 選択されたドキュメントをビューアーで表示
+3. タグ管理画面へ推移
+4. タグ追加ダイアログの表示
+
+<div class="page-break"></div>
+

documents/flow/scan.md

@@ -0,0 +1,17 @@
+## スキャンフロー
+
+<div class="flow_img">
+
+![スキャンフロー](/documents/img/flow/scan_flow.png)
+
+</div>
+
+
+5. スキャナ起動
+6. ページ追加
+7. スキャン結果確認, 処理選択
+8. 新規保存(右上左側)
+9. 既存のドキュメントに追加(右上右側)
+
+<div class="page-break"></div>
+

documents/flow/viewer.md

@@ -0,0 +1,19 @@
+## ビューアフロー
+
+<div class="flow_img">
+
+![ビューアフロー](/documents/img/flow/viewer_flow.png)
+
+</div>
+
+
+10. ファイル削除(右上左端)
+11. ファイル結合(右上右端)
+12. メニュー展開(右上三点メニュー)
+13. ファイル名変更
+14. ファイルの移動
+15. タグ適用
+16. 表示するリビジョン(遡るバージョン)の選択
+
+<div class="page-break"></div>
+

documents/flow/viewer_combined.md

@@ -0,0 +1,16 @@
+## ビューア(結合済)フロー
+
+<div class="flow_img">
+
+![ビューアフロー](/documents/img/flow/viewer_combined_flow.png)
+
+</div>
+
+
+17. ドキュメント切り替え(タブ)
+18. メニュー展開
+19. アイテム名(タブ名, =ファイル名)変更
+20. 表示するリビジョン(遡るバージョン)の選択
+
+<div class="page-break"></div>
+

documents/home/index.md

@@ -0,0 +1,22 @@
+# 各画面詳細
+## ホーム画面
+### トップ画面
+
+<div class="ss_img">
+
+![ホーム画面](/documents/img/ss/home/home_index.png)
+
+</div>
+
+#### 概要
+- 最終更新日時の新しい順にドキュメントが表示されます
+
+#### 詳細
+- フォルダは表示されません
+
+#### 予定(TODO)
+- ピン留め機能
+
+<!-- 改ページ -->
+<div class="page-break"></div>
+

documents/library/index.md

@@ -0,0 +1,22 @@
+## ライブラリ画面
+### トップ画面
+
+<div class="ss_img">
+
+![ライブラリ画面](/documents/img/ss/library/library_index.png)
+
+</div>
+
+#### 概要
+- 作成したドキュメント, フォルダが表示されます
+
+#### 詳細
+- タグが設定されている場合,タイトル下に表示されます
+- フォルダタップで推移できます
+
+#### 予定(TODO)
+- タグ検索機能
+
+<!-- 改ページ -->
+<div class="page-break"></div>
+

documents/main.md

@@ -1,120 +0,0 @@
-
-# Markdown Example
-
-## 1. **Basic Formatting**
-
-You can make text **bold** or *italic*.
-
-**Bold and _Italic_** can be combined.
-
----
-
-## 2. **Lists**
-
-### Unordered List:
-- Item 1
-  - Subitem 1.1
-  - Subitem 1.2
-- Item 2
-
-### Ordered List:
-1. First item
-2. Second item
-   1. Subitem 2.1
-   2. Subitem 2.2
-
----
-
-## 3. **Links and Images**
-
-[OpenAI](https://www.openai.com)
-
-<!-- ![OpenAI Logo](https://www.openai.com/favicon.ico) -->
-
----
-
-## 4. **Blockquotes**
-
-> "The only limit to our realization of tomorrow is our doubts of today."  
-> — *Franklin D. Roosevelt*
-
----
-
-## 5. **Code Blocks**
-
-Inline code: `print("Hello, World!")`
-
-Python code block:
-```python
-def greet(name):
-    print(f"Hello, {name}!")
-greet("Markdown")
-```
-
----
-
-## 6. **Tables**
-
-| Name     | Age | Country |
-|----------|-----|---------|
-| Alice    | 24  | USA     |
-| Bob      | 30  | UK      |
-| Charlie  | 28  | Canada  |
-
----
-
-## 7. **Task Lists**
-
-- [x] Write a markdown example
-- [ ] Review the document
-- [ ] Submit the assignment
-
----
-
-## 8. **Footnotes**
-
-This is a statement with a footnote.[^1]
-
-[^1]: This is the footnote explaining the statement.
-
----
-
-## 9. **Horizontal Rules**
-
----
-
-## 10. **Emojis**
-
-Let's celebrate :tada: and have some fun :smile:!
-
----
-
-## 11. **Heading with ID**
-
-### Custom Heading {#custom-heading}
-
-You can link to [this heading](#custom-heading) using its ID.
-
----
-
-## 12. **Highlighting**
-
-==This text is highlighted== for emphasis.
-
----
-
-## 13. **Mathematical Expressions**
-
-You can include math using LaTeX:  
-$$ E = mc^2 $$
-
----
-
-## 14. **HTML Elements**
-
-You can also use HTML elements:  
-<kbd>Ctrl</kbd> + <kbd>C</kbd> to copy.
-
----
-
-Enjoy experimenting with **Markdown**!

documents/settings/index.md

@@ -0,0 +1,26 @@
+## 設定画面
+### トップ画面
+
+<div class="ss_img">
+
+![設定画面](/documents/img/ss/settings/settings_index.png)
+
+</div>
+
+#### 概要
+- アプリの基本的な設定が行えます
+
+#### 詳細
+- 表示(WIP)
+- データ(WIP)
+- スキャン(WIP)
+- タグ管理
+  - タグの追加, 編集(WIP), 削除(WIP)を行う画面へ遷移します
+- このアプリについて(WIP)
+
+#### 予定(TODO)
+- WIP画面の実装
+
+<!-- 改ページ -->
+<div class="page-break"></div>
+

documents/settings/tag_manage.md

@@ -0,0 +1,25 @@
+### タグ管理画面
+
+<div class="ss_img">
+
+![タグ一覧1](/documents/img/ss/settings/settings_tag_list.png)
+![タグ追加ダイアログ(入力済み)](/documents/img/ss/settings/settings_tag_add_dialog_2.png)
+
+</div>
+
+#### 概要
+- タグの作成, 編集(WIP), 削除(WIP)が行えます
+
+#### 詳細
+- 右下のFABをタップすることでタグ追加ダイアログが表示されます
+- タグ追加ダイアログにタグ名, タグカラーを入力し, OKボタンをタップすることでタグが追加されます
+  - タグカラーは[`android.graphics.Color`の`parseColor`メソッド](https://developer.android.com/reference/android/graphics/Color#parseColor(java.lang.String))で解釈可能な文字列を入力してください
+    - e.g. `#FF0000`, `red`
+
+#### 予定(TODO)
+- カラーピッカーの実装
+- タグ編集, 削除機能の実装
+
+<!-- 改ページ -->
+<div class="page-break"></div>
+

documents/viewer/index.md

@@ -0,0 +1,25 @@
+## ビューア画面
+### トップ画面
+
+<div class="ss_img">
+
+![ビューア画面](/documents/img/ss/viewer/viewer_index.png)
+![ビューア画面(削除ダイアログ)](/documents/img/ss/viewer/viewer_delete_dialog.png)
+![ビューア画面(結合ダイアログ)](/documents/img/ss/viewer/viewer_combine_dialog.png)
+
+</div>
+
+#### 概要
+- スキャンしたデータの表示, 編集, 削除が行えます
+
+#### 詳細
+- スキャンしたドキュメントが表示されます
+- 右上ゴミ箱アイコンをタップすることでドキュメントを削除します
+- 右上マージアイコンをタップすることでドキュメントを結合します
+
+#### 予定(TODO)
+- 
+
+<!-- 改ページ -->
+<div class="page-break"></div>
+

documents/viewer/menu.md

@@ -0,0 +1,29 @@
+### メニュー
+
+<div class="ss_img">
+
+![メニュー展開](/documents/img/ss/viewer/viewer_menu_open.png)
+
+</div>
+
+#### 概要
+- 詳細な操作を行うためのメニューです
+
+#### 詳細
+- 右上三点メニューをタップすることでメニューが展開します
+  - メニュー項目
+    - バージョン履歴
+      - ドキュメントのバージョン履歴を表示します
+    - リネーム
+      - ドキュメントの名前を変更します
+    - 移動
+      - ドキュメントを別のフォルダに移動します
+    - タグの管理
+      - ドキュメントにタグを追加, 削除します
+
+#### 予定(TODO)
+- 文言の修正
+
+<!-- 改ページ -->
+<div class="page-break"></div>
+

documents/viewer/rename.md

@@ -0,0 +1,20 @@
+### リネーム
+
+<div class="ss_img">
+
+![リネームダイアログ](/documents/img/ss/viewer/viewer_rename.png)
+
+</div>
+
+#### 概要
+- ドキュメントの名前を変更します
+
+#### 詳細
+- 新しい名前を入力し, 変更ボタンをタップすることで名前が変更されます
+
+#### 予定(TODO)
+- サジェストの実装
+
+<!-- 改ページ -->
+<div class="page-break"></div>
+

documents/viewer/rev.md

@@ -0,0 +1,20 @@
+### バージョン履歴
+
+<div class="ss_img">
+
+![バージョン履歴ダイアログ](/documents/img/ss/viewer/viewer_select_rev.png)
+
+</div>
+
+#### 概要
+- バージョン履歴を表示します
+
+#### 詳細
+- 遡りたいバージョンを選択し, 選択ボタンをタップすることで選択したバージョンに戻ります
+
+#### 予定(TODO)
+- コミットメッセージ修正機能を実装
+
+<!-- 改ページ -->
+<div class="page-break"></div>
+

documents/viewer/tag.md

@@ -0,0 +1,21 @@
+### タグ適用
+
+<div class="ss_img">
+
+![タグ適用ダイアログ](/documents/img/ss/viewer/viewer_tag_apply_dialog.png)
+
+</div>
+
+#### 概要
+- 設定画面で作成したタグをドキュメントに適用します
+
+#### 詳細
+- チェックボックスがオンのタグが適用されます
+
+#### 予定(TODO)
+- タグカラーの表示
+- タグ作成画面への推移
+
+<!-- 改ページ -->
+<div class="page-break"></div>
+

documents/viewer/update.md

@@ -0,0 +1,23 @@
+### ページ更新
+
+<div class="ss_img">
+
+![トップ](/documents/img/ss/viewer/viewer_update_index.png)
+![更新ダイアログ](/documents/img/ss/viewer/viewer_update_dialog.png)
+
+</div>
+
+#### 概要
+- ドキュメントの任意のページを更新できます
+
+#### 詳細
+- 画面上のロングタップしたページを更新します
+
+#### 予定(TODO)
+- 一括更新の実装
+- MediaPickerからの更新
+- UX改善
+
+<!-- 改ページ -->
+<div class="page-break"></div>
+

documents/viewer_combined/index.md

@@ -0,0 +1,24 @@
+## ビューア画面(結合済み)
+### トップ画面
+
+<div class="ss_img">
+
+![ビューア画面(ページ1)](/documents/img/ss/viewer/viewer_combined_index_page1.png)
+![ビューア画面(ページ2)](/documents/img/ss/viewer/viewer_combined_index_page2.png)
+
+</div>
+
+#### 概要
+- 結合したドキュメントの表示, 編集, 削除が行えます
+
+#### 詳細
+- 表示部上のタブを選択 or スワイプすることでそれぞれを切り替えます
+
+#### 予定(TODO)
+- 位置関係を記録できるようにする
+- タブ並べ替え
+- UX改善
+
+<!-- 改ページ -->
+<div class="page-break"></div>
+

documents/viewer_combined/menu.md

@@ -0,0 +1,27 @@
+### メニュー
+
+<div class="ss_img">
+
+![メニュー展開](/documents/img/ss/viewer/viewer_combined_menu_open.png)
+
+</div>
+
+#### 概要
+- 詳細な操作を行うためのメニューです
+
+#### 詳細
+- 右側三点メニューをタップすることでメニューが展開します
+  - メニュー項目
+    - 過去のリビジョン
+      - ドキュメントのバージョン履歴を表示します
+    - リネーム
+      - ドキュメントの名前を変更します
+    - 削除
+      - アイテムを削除します
+
+#### 予定(TODO)
+- 文言の修正
+
+<!-- 改ページ -->
+<div class="page-break"></div>
+

documents/viewer_combined/rename.md

@@ -0,0 +1,20 @@
+### リネーム
+
+<div class="ss_img">
+
+![リネームダイアログ](/documents/img/ss/viewer/viewer_combined_item_rename_dialog.png)
+
+</div>
+
+#### 概要
+- アイテムの名前を変更します
+
+#### 詳細
+- 新しい名前を入力し, 変更ボタンをタップすることで名前が変更されます
+
+#### 予定(TODO)
+- サジェストの実装
+
+<!-- 改ページ -->
+<div class="page-break"></div>
+

documents/viewer_combined/rev.md

@@ -0,0 +1,17 @@
+### バージョン履歴
+
+<div class="ss_img">
+
+![バージョン履歴ダイアログ](/documents/img/ss/viewer/viewer_combined_select_rev.png)
+
+</div>
+
+#### 概要
+- バージョン履歴を表示します
+
+#### 詳細
+- 遡りたいバージョンを選択し, 選択ボタンをタップすることで選択したバージョンに戻ります
+
+#### 予定(TODO)
+- コミットメッセージ修正機能を実装
+

package-lock.json

@@ -1,11 +1,11 @@
 {
-    "name": "md2pdf-mod",
+    "name": "md2pdf-meow",
     "version": "1.0.0",
     "lockfileVersion": 3,
     "requires": true,
     "packages": {
         "": {
-            "name": "md2pdf-mod",
+            "name": "md2pdf-meow",
             "version": "1.0.0",
             "license": "MIT",
             "dependencies": {

package.json

@@ -7,7 +7,7 @@
         "build:step2": "npx doctoc --notitle --maxlevel 3 work/all.md",
         "build:step3": "node scripts/mdit.js work/all.md work/all_md.html",
         "build:step4": "node scripts/ejs.js template/template.html work/all.html",
-        "build:step5": "npx html-inline work/all.html -b doc -o dist/all.html",
+        "build:step5": "npx html-inline work/all.html -b ./ -o dist/all.html",
         "build:step6": "npx tsx scripts/convert.ts",
         "build": "npm run build:step1 && npm run build:step2 && npm run build:step3 && npm run build:step4 && npm run build:step5 && npm run build:step6"
     },

template/template.html

@@ -4,24 +4,30 @@
   <meta charset="utf-8">
   <meta name="openaction" content="#view=fit">
   <meta name="author" content="r-ca" />
-  <title>Template</title>
-  <link rel="stylesheet" href="../css/github-markdown.css">
-  <link rel="stylesheet" href="../css/custom.css">
+  <title>Lacerta 操作説明文書</title>
+  <link rel="stylesheet" href="/css/github-markdown.css">
+  <link rel="stylesheet" href="/css/custom.css">
+  <link rel="stylesheet" href="/css/fix.css">
 </head>
 <body>
   <div class="FrontCover">
-    <h1>Template</h1>
-    <div class="Published">0000/000/00</div>
-    <div class="Author">ろむねこ</div>
+    <h1>Lacerta 操作説明文書</h1>
+    <div class="Published">2024/08/24</div>
+    <div class="Author">グループワークチーム「Lacerta-doc」</div>
   </div>
   <article class="markdown-body">
   <%- include('../work/all_md.html') %>
   </article>
   <div class="BackCover">
     <div class="Colophon">
-      <span class="Title">Template</span><br>
-      <span class="PubDate">0000/000/00</span><br>
-      <span class="Copyright">template</span>
+      <span class="Title">Lacerta 操作説明文書</span><br>
+      <span class="PubDate">2024/08/24</span><br>
+      <span class="Copyright">© 2024 Lacerta-doc</span><br>
+      <span class="License">
+        この文書は、<a herf="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License (CC-BY-4.0)</a> の下でライセンスされています。<br>
+        このライセンスは、文書の内容にのみ適用され、文書生成に使用されたスクリプトには適用されません。<br>
+        Repo: https://git.nem.one/lacerta-dev/docs-operation
+      </span>
     </div>
   </div>
 </body>