Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ヘルプページを記述 #320

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added help/docs/assets/add_custom_pointer.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 help/docs/assets/arrow.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 help/docs/assets/arrow_finger.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 help/docs/assets/create_invite_link.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 help/docs/assets/create_new_pointer.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 help/docs/assets/finger.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 help/docs/assets/invite_link.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 help/docs/assets/join_from_webapp.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 help/docs/assets/menu.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 help/docs/assets/reopen_invite_link.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 help/docs/assets/rest_time_notify.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 help/docs/assets/select_custom_pointer.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 help/docs/assets/select_pointer_design.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 help/docs/assets/setting_pointer.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 help/docs/assets/slide_controll.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 help/docs/assets/timer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 10 additions & 1 deletion help/docs/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,10 @@
# 概要
# はじめに

こちらは『スマートポインター』のヘルプページです.

ここではデスクトップアプリケーション及びリモコン用Webアプリの各機能の概要,操作手順などをまとめています.

より詳しい設計や技術構成は以下を御覧ください.

- [ソースコード](https://github.com/jphacks/D_2208)
- [Wiki](https://github.com/jphacks/D_2208/wiki)
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# ルーム作成と招待リンクの表示

## 概要

『スマートポインター』の機能を使うにはデスクトップアプリケーションで作成したルームにリモコン用Webアプリケーションから入室する必要があります.リモコン用Webアプリは同一ルームのPCに対して,レーザーポインターやスライド送りの機能を使用することができます.1つのPCに対して複数のリモコン用Webアプリから操作をすることができます.

招待リンクはリモコン用Webアプリがルームに入室する際に使用します.

## 手順

- デスクトップアプリケーションを起動します
- タスクトレイに表示されたスマートポインターのアイコンを右クリックし,メニューを開きます
![メニュー](../assets/menu.png)
- `ルームを作成`をクリックしルームを作成します
!!! note
現在 Linux にて Wayland セッションでログイン中に「スマートポインター」のルームを作成した際に、一部のウィンドウやウィンドウのフレームの操作が動作しない不具合があります。この不具合が発生する場合は XOrg セッションに切り替えて使用してください
- ルームを作成すると以下のウィンドウが表示されるので,`クリックして招待リンクを表示`をクリックします
![招待リンクの表示](../assets/create_invite_link.png)
- 表示された招待リンクをリモコン用Webアプリで使用するスマートフォンに共有します
![招待リンク](../assets/invite_link.png)
- 招待リンクのウィンドウを削除した後,再度表示する場合はメニューから`招待リンクの表示`を選択します
![招待リンク再表示](../assets/reopen_invite_link.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# ポインターデザインの変更

## 概要

『スマートポインター』のポインターの見た目はスポットライトから矢印や人差し指,自前の画像に変更することもできます.
![矢印](../assets/arrow_finger.png)

## 手順

- ルームを作成した状態でタスクトレイのアイコンを右クリックしメニューを開きます
- メニューの`ポインター`から変更したいポインターのデザインを選択します
![ポインターデザイン選択](../assets/select_pointer_design.png)
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# カスタムポインターの作成

## 概要

『スマートポインター』で自前の画像をポインターのデザインとして使用するには,事前に画像を追加する必要があります.

## 手順

- ルームを作成した状態でタスクトレイにあるアイコンを右クリックしてメニューを開きます
- メニューから`自作ポインターの設定`を選択します
![自作ポインターの設定](../assets/create_new_pointer.png)
- 設定ウィンドウから`カスタムポインター名`を設定し,ポインターとして使用したい画像をアップロードします
- 例
![自作ポインターの設定](../assets/add_custom_pointer.png)
- 2つ目以降は右上の`追加する`ボタンをクリックした後,同様の操作を行ってください
- 追加した画像はメニューの`ポインター`から選択することで使用できるようになります
![自作ポインターの選択](../assets/select_custom_pointer.png)
12 changes: 12 additions & 0 deletions help/docs/リモコン用Webアプリ/1 ルームへの入室.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# ルームへの入室

## 概要

リモコン用アプリからPCを操作するには同じルームに入室している必要があります,

## 手順

- デスクトップアプリケーションから共有された招待リンクにブラウザからアクセスします
- 必要であればルームID,パスコードを入力します
- `ルームに参加`をクリックします
![ルームに参加](../assets/join_from_webapp.png)
14 changes: 14 additions & 0 deletions help/docs/リモコン用Webアプリ/2 タイマー.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# タイマー

## 概要

『スマートポインター』にはタイマー機能が付いており,これを使うことでプレゼンの残り時間をスマートに管理することができます.タイマーの残り時間は同一ルームに参加しているリモコン用Webアプリ間で共有されます.

また,このタイマーでは残り時間通知を設定することができます.設定時間まで到達するとトースト通知されます.

## 残り時間通知の設定

- タイマー部右下の歯車ボタンをクリックします
![タイマー](../assets/timer.png)
- 通知してほしい残り時間を入力し,`完了`をクリックします
![残り時間通知](../assets/rest_time_notify.png)
16 changes: 16 additions & 0 deletions help/docs/リモコン用Webアプリ/3 ポインター.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# ポインター

## 概要

PCの画面上に画像またはスポットライトを表示し,レーザーポインターの様に一部分を強調表示することができます.

『スマートポインター』では複数のリモコン用Webアプリから同時にポインターを表示することができます.
各リモコンから指し示されているポインターの右下にはルーム入室時に入力したユーザ名が表示され,ポインターを区別することができます.

## 操作方法

『スマートポインター』のポインターは従来のレーザーポインターと同じように操作できます.
ルームに入室後,画面中央にあるボタンをクリックするとポインターが表示されます.

ポインターの種類はデフォルトのスポットライトの他,矢印,人差し指,カスタムポインターから選択することができます.
詳しくは[ポインターデザインの変更](../デスクトップアプリケーション/2%20ポインターデザインの変更.md)を御覧ください.
11 changes: 11 additions & 0 deletions help/docs/リモコン用Webアプリ/4 スライド操作.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# スライド操作

## 概要

リモコン用WebアプリからPC上のスライドショーのスライドを進めたり,戻したりできます.

## 手順

- PC上でスライドショーを立ち上げた状態で画面下の矢印ボタンをクリックします
- `>`をクリックするとスライドが次に進み,`<`をクリックするとスライドが前に戻ります
![スライド操作](../assets/slide_controll.png)