Skip to content

Commit

Permalink
ヘルプとマニュアルの更新
Browse files Browse the repository at this point in the history
  • Loading branch information
twsnmp committed Feb 14, 2024
1 parent 541f60c commit 20cff5c
Show file tree
Hide file tree
Showing 19 changed files with 77 additions and 19 deletions.
14 changes: 11 additions & 3 deletions doc/twsnmpfk_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Click the 🌙 mark on the upper right to dark mode.I like dark mode.Probably th

Right -click the location other than the node and drawing items on the map to display.

![h:400 center](../frontend/src/help/en/2023-12-03_10-22-50.png)
![h:400 center](../frontend/src/help/en/2024-02-15_04-58-57.png)

---
| Menu | Operation |
Expand All @@ -109,8 +109,9 @@ Right -click the location other than the node and drawing items on the map to di
| Check all | Reconfirm the node that has occurred.|
| Discover | Displays the automatic discovery screen.|
| Grid | Align the position of the node at the specified interval.|
| Backgrand image| set backgrand image to map|
| Reload | Update the map to the latest state.|
| edit mode | All drawing items are displayed regardless of the state of the map.|
| Edit mode | All drawing items are displayed regardless of the state of the map.|


---
Expand Down Expand Up @@ -1078,7 +1079,7 @@ The port number is specified by the startup parameter of the program.
## Notification settings
This is the screen to set the notification.

![h:400 center](../frontend/src/help/en/2023-12-03_11-17-34.png)
![h:400 center](../frontend/src/help/en/2024-02-15_05-32-34.png)

---
| Items | Contents |
Expand All @@ -1100,6 +1101,12 @@ This is the screen to set the notification.
---
| Items | Contents |
| ---- | ---- |
| Line Notification level | Specify the monitoring level to send LINE notifications.|
| Repair notification | We will also send an email when you repair.|
| LINE Token| LINE Notify token|
---
| Items | Contents |
| ---- | ---- |
| Command execution | Run the command specified in the state parameter when the map changes.<br> $ Level is in the map.0: Severe, 1: Mild, 2: Note, 3: Normal, -1: Unknown |
| Sounds played during severe disorders | Specify the audio file to play when the state of the map is severe.|
| Sounds played during mild disability | Specify the audio file to be played when the state of the map is mild.|
Expand All @@ -1109,6 +1116,7 @@ This is the screen to set the notification.
### Email send test

Click the <Test> button to send the test email with the configured content.
Click the <LINE Test> button to send the test LINE message with the configured content.


---
Expand Down
Binary file modified doc/twsnmpfk_en.pdf
Binary file not shown.
32 changes: 29 additions & 3 deletions doc/twsnmpfk_ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ By 先代助手の猫

マップ上のノードや描画アイテム以外の場所を右クリックして表示します。

![h:400 center](../frontend/src/help/ja/2023-11-26_20-46-50.png)
![h:400 center](../frontend/src/help/ja/2024-02-15_04-28-34.png)

---

Expand All @@ -142,9 +142,24 @@ By 先代助手の猫
|全て再確認|障害が発生しているノードを再確認します。|
|自動発見|自動発見画面を表示します。|
|グリッド整列|ノードの位置を指定の間隔に整列します。|
|背景画像|マップの背景に表示する画像を設定します。|
|更新|マップの表示を最新の状態に更新します。|
|アイテム編集表示|全ての描画アイテムをマップの状態に関わらず表示します。|

---
#### 背景画像設定

背景の画像を設定するダイアログです。X、Yで左上の座標を指定します。幅と高さ画像ファイルを選択してください。

![背景画像設定 center](../frontend/src/help/ja/2024-02-15_04-28-50.png)

---
#### グリッド整列

マップのアイコンを指定した間隔に整列するダイアログです。間隔を指定します。変更する前に<テスト>ボタンで表示を確認できます。

![グリッド整列 center](../frontend/src/help/ja/2024-02-15_04-29-08.png)


---
### ノードメニュー
Expand Down Expand Up @@ -1151,7 +1166,7 @@ System情報の画面です。上部にログのリソースと通信の情報
## 通知設定
通知の設定をする画面です。

![h:400 center](../frontend/src/help/ja/2023-11-29_05-01-22.png)
![h:400 center](../frontend/src/help/ja/2024-02-15_05-05-50.png)

---
|項目|内容|
Expand All @@ -1162,6 +1177,7 @@ System情報の画面です。上部にログのリソースと通信の情報
|パスワード|メール送信認証のパスワードを設定します。|
|送信元|送信元のメールアドレスです。|
|宛先|通知メールの宛先メールアドレスです。<br>カンマ区切りで複数指定できます。|

---
|項目|内容|
|----|----|
Expand All @@ -1170,6 +1186,14 @@ System情報の画面です。上部にログのリソースと通信の情報
|通知間隔|通知のチェックを行う間隔を指定します。|
|定期レポート|日報の送信を行います。|
|復帰通知|復帰した時もメールを送信します。|

---
|項目|内容|
|----|----|
|LINE通知レベル|LINEへ障害通知を送信する監視レベルを指定します。|
|復帰通知|復帰した時もLINEへ通知を送信します。|
|LINEトークン|LINE Notifyへメッセージを送信するためのトークンです。|

---
|項目|内容|
|----|----|
Expand All @@ -1178,9 +1202,11 @@ System情報の画面です。上部にログのリソースと通信の情報
|軽度障害の再生音|マップの状態が軽度の時に再生する音声ファイルを指定します。|

---
### メール送信テスト
### 送信テスト

<テスト>ボタンをクリックすれば、設定した内容でテストメールを送信します。
<LINEテスト>ボタンをクリックすれば、設定した内容でLINEへテストメッセージ
を送信します。

---
## AI分析設定
Expand Down
Binary file modified doc/twsnmpfk_ja.pdf
Binary file not shown.
Binary file removed frontend/src/help/en/2023-12-03_10-22-50.png
Binary file not shown.
Binary file removed frontend/src/help/en/2023-12-03_11-17-34.png
Binary file not shown.
Binary file added frontend/src/help/en/2024-02-15_04-58-57.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added frontend/src/help/en/2024-02-15_05-32-34.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions frontend/src/help/en/map.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Upper right<span class="mdi mdi-moon-waxing-crescent"></span>Switch to dark mode
Right -click the location other than the node and drawing items on the map to display.
</div>

![Map menu](../../help/en/2023-12-03_10-22-50.png)
![Map menu](../../help/en/2024-02-15_04-58-57.png)

>>>
#### Map menu
Expand All @@ -55,8 +55,9 @@ Right -click the location other than the node and drawing items on the map to di
| Check all | Reconfirm the node that has occurred.|
| discover | Displays the automatic discovery screen.|
| Grid | Align the position of the node at the specified interval.|
| Backgrand image| set backgrand image to map|
| Relaod | Update the map to the latest state.|
| edit mode | All drawing items are displayed regardless of the state of the map.|
| Edit mode | All drawing items are displayed regardless of the state of the map.|

</div>

Expand Down
12 changes: 7 additions & 5 deletions frontend/src/help/en/notifyconf.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
This is the screen to set the notification.
</div>

![Notification settings](../../help/en/2023-12-03_11-17-34.png)
![Notification settings](../../help/en/2024-02-15_05-32-34.png)

>>>
<div class="text-lg">
<div class="text-sm">

| Items | Contents |
| ---- | ---- |
Expand All @@ -18,10 +18,11 @@ This is the screen to set the notification.
| Sending source | Sending source email address.|
| Address | Notification email destination email address.<BR> You can specify multiple by separation of comma.|
Subject | Notification email subject.|
| Notification level | Specify the monitoring level to send disability notifications.|
| Notification level | Specify the monitoring level to send notifications.|
| Notification interval | Specify the interval to check the notification.|
| Regular report | Send a daily report.|
| Return notification | We will also send an email when you return.|
| Notify repair | We will also send an email when you reapir.|
| LINE Level| Specify notification level fo LINE.|
| LINE Token| LINE Notify token|
| Comment execution | Run the command specified in the state parameter when the map changes.<br> $ Level is in the map.0: Severe, 1: Mild, 2: Note, 3: Normal, -1: Unknown |
| Sounds played during severe disorders | Specify the audio file to play when the state of the map is severe.|
| Sounds played during mild disability | Specify the audio file to be played when the state of the map is mild.|
Expand All @@ -33,5 +34,6 @@ Subject | Notification email subject.|

<div class="text-xl">
Click the <Test> button to send the test email with the configured content.
Click the <LINE Test> button to send the test LINE message with the configured content.
</div>

Binary file removed frontend/src/help/ja/2023-11-26_20-46-50.png
Binary file not shown.
Binary file removed frontend/src/help/ja/2023-11-29_05-01-22.png
Binary file not shown.
Binary file added frontend/src/help/ja/2024-02-15_04-28-34.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added frontend/src/help/ja/2024-02-15_04-28-50.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added frontend/src/help/ja/2024-02-15_04-29-08.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added frontend/src/help/ja/2024-02-15_05-05-50.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 17 additions & 1 deletion frontend/src/help/ja/map.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
マップ上のノードや描画アイテム以外の場所を右クリックして表示します。
</div>

![マップメニュー](../../help/ja/2023-11-26_20-46-50.png)
![マップメニュー](../../help/ja/2024-02-15_04-28-34.png)

>>>
#### マップメニューの説明
Expand All @@ -56,12 +56,28 @@
|描画アイテム|描画アイテムをマップに追加します。|
|全て再確認|障害が発生しているノードを再確認します。|
|自動発見|自動発見画面を表示します。|
|背景画像|マップの背景に表示する画像を設定します。|
|グリッド整列|ノードの位置を指定の間隔に整列します。|
|更新|マップの表示を最新の状態に更新します。|
|アイテム編集表示|全ての描画アイテムをマップの状態に関わらず表示します。|

</div>

>>>
#### 背景画像設定

背景の画像を設定するダイアログです。X、Yで左上の座標を指定します。幅と高さ画像ファイルを選択してください。

![背景画像設定](../../help/ja/2024-02-15_04-28-50.png)

>>>
#### グリッド整列

マップのアイコンを指定した間隔に整列するダイアログです。間隔を指定します。変更する前に<テスト>ボタンで表示を確認できます。

![グリッド整列](../../help/ja/2024-02-15_04-29-08.png)


---
#### ノードメニュー

Expand Down
11 changes: 8 additions & 3 deletions frontend/src/help/ja/notifyconf.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
通知の設定をする画面です。
</div>

![通知設定](../../help/ja/2023-11-29_05-01-22.png)
![通知設定](../../help/ja/2024-02-15_05-05-50.png)

>>>
<div class="text-lg">
<div class="text-sm">

|項目|内容|
|----|----|
Expand All @@ -22,17 +22,22 @@
|通知間隔|通知のチェックを行う間隔を指定します。|
|定期レポート|日報の送信を行います。|
|復帰通知|復帰した時もメールを送信します。|
|LINE通知レベル|LINEへ障害通知を送信する監視レベルを指定します。|
|復帰通知|復帰した時もLINEへ通知を送信します。|
|LINEトークン|LINE Notifyへメッセージを送信するためのトークンです。|
|コマンド実行|マップの状態変化時に状態パラメーターに指定したコマンドを実行します。<br> $levelがマップの状態です。0:重度,1:軽度,2:注意,3:正常,-1:不明|
|重度障害時に再生する音|マップの状態が重度の時に再生する音声ファイルを指定します。|
|軽度障害時に再生する音|マップの状態が軽度の時に再生する音声ファイルを指定します。|

</div>

---
#### メール送信テスト
#### 送信テスト

<div class="text-xl">
<テスト>ボタンをクリックすれば、設定した内容でテストメールを送信します。
<LINEテスト>ボタンをクリックすれば、設定した内容でLINEへテストメッセージ
を送信します。

</div>

4 changes: 2 additions & 2 deletions frontend/src/i18n/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -390,8 +390,8 @@
"Reload": "Reload",
"Report": "Report",
"Test": "Test",
"showDrawItemEdit": "edit mode",
"showDrawItemNomal": "normal mode",
"showDrawItemEdit": "Edit mode",
"showDrawItemNomal": "Normal mode",
"BackImage": "Backgrand image",
"Clear": "Clear",
"Save": "Save"
Expand Down

0 comments on commit 20cff5c

Please sign in to comment.