summaryrefslogtreecommitdiff
path: root/src/docs
diff options
context:
space:
mode:
authorsyuilo <Syuilotan@yahoo.co.jp>2018-10-08 15:37:24 +0900
committerGitHub <noreply@github.com>2018-10-08 15:37:24 +0900
commit9c170c426be01773afb15a9868ff3c278e09409c (patch)
tree0229bb52dd9197308d193f4e41bbc11d3dcb95a1 /src/docs
parentNew translations ja-JP.yml (Norwegian) (diff)
parentfix(package): update @types/mongodb to version 3.1.10 (#2849) (diff)
downloadmisskey-9c170c426be01773afb15a9868ff3c278e09409c.tar.gz
misskey-9c170c426be01773afb15a9868ff3c278e09409c.tar.bz2
misskey-9c170c426be01773afb15a9868ff3c278e09409c.zip
Merge branch 'develop' into l10n_develop
Diffstat (limited to 'src/docs')
-rw-r--r--src/docs/api/entities/note.yaml12
-rw-r--r--src/docs/api/entities/user.yaml8
-rw-r--r--src/docs/base.pug2
-rw-r--r--src/docs/keyboard-shortcut.ja-JP.md97
-rw-r--r--src/docs/stream.ja-JP.md8
-rw-r--r--src/docs/style.styl21
6 files changed, 133 insertions, 15 deletions
diff --git a/src/docs/api/entities/note.yaml b/src/docs/api/entities/note.yaml
index cae9a53f82..6654be2b02 100644
--- a/src/docs/api/entities/note.yaml
+++ b/src/docs/api/entities/note.yaml
@@ -33,19 +33,19 @@ props:
ja-JP: "投稿の本文"
en-US: "The text of this note"
- mediaIds:
+ fileIds:
type: "id(DriveFile)[]"
optional: true
desc:
- ja-JP: "添付されているメディアのID (なければレスポンスでは空配列)"
- en-US: "The IDs of the attached media (empty array for response if no media is attached)"
+ ja-JP: "添付されているファイルのID (なければレスポンスでは空配列)"
+ en-US: "The IDs of the attached files (empty array for response if no files is attached)"
- media:
+ files:
type: "entity(DriveFile)[]"
optional: true
desc:
- ja-JP: "添付されているメディア"
- en-US: "The attached media"
+ ja-JP: "添付されているファイル"
+ en-US: "The attached files"
userId:
type: "id(User)"
diff --git a/src/docs/api/entities/user.yaml b/src/docs/api/entities/user.yaml
index c90b55ee88..e3755d8585 100644
--- a/src/docs/api/entities/user.yaml
+++ b/src/docs/api/entities/user.yaml
@@ -101,15 +101,15 @@ props:
ja-JP: "投稿の数"
en-US: "The number of the notes of this user"
- pinnedNote:
- type: "entity(Note)"
+ pinnedNotes:
+ type: "entity(Note)[]"
optional: true
desc:
ja-JP: "ピン留めされた投稿"
en-US: "The pinned note of this user"
- pinnedNoteId:
- type: "id(Note)"
+ pinnedNoteIds:
+ type: "id(Note)[]"
optional: true
desc:
ja-JP: "ピン留めされた投稿のID"
diff --git a/src/docs/base.pug b/src/docs/base.pug
index 26f19ddf09..41eb80a64e 100644
--- a/src/docs/base.pug
+++ b/src/docs/base.pug
@@ -9,7 +9,7 @@ html(lang= lang)
link(rel="stylesheet" href="/docs/assets/style.css")
link(rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/default.min.css")
script(src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js")
- link(rel="stylesheet" href="https://use.fontawesome.com/releases/v5.1.0/css/all.css" integrity="sha384-lKuwvrZot6UHsBSfcMvOkWwlCMgc0TaWr+30HWe3a4ltaBwTZhyTEggF5tJv8tbt" crossorigin="anonymous")
+ link(rel="stylesheet" href="https://use.fontawesome.com/releases/v5.3.1/css/all.css" integrity="sha384-mzrmE5qonljUremFsqc01SB46JvROS7bZs3IO2EmfFsd15uHvIt+Y8vEf7N7fWAU" crossorigin="anonymous")
block meta
body
diff --git a/src/docs/keyboard-shortcut.ja-JP.md b/src/docs/keyboard-shortcut.ja-JP.md
new file mode 100644
index 0000000000..264387242c
--- /dev/null
+++ b/src/docs/keyboard-shortcut.ja-JP.md
@@ -0,0 +1,97 @@
+# キーボードショートカット
+
+## グローバル
+これらのショートカットは基本的にどこでも使えます。
+<table>
+ <thead>
+ <tr><th>ショートカット</th><th>効果</th><th>由来</th></tr>
+ </thead>
+ <tbody>
+ <tr><td><kbd class="key">P</kbd>, <kbd class="key">N</kbd></td><td>新規投稿</td><td><b>P</b>ost, <b>N</b>ew, <b>N</b>ote</td></tr>
+ <tr><td><kbd class="key">T</kbd></td><td>タイムラインの最も新しい投稿にフォーカス</td><td><b>T</b>imeline, <b>T</b>op</td></tr>
+ <tr><td><kbd class="group"><kbd class="key">Shift</kbd> + <kbd class="key">N</kbd></kbd></td><td>通知を表示/隠す</td><td><b>N</b>otifications</td></tr>
+ <tr><td><kbd class="key">A</kbd>, <kbd class="key">M</kbd></td><td>アカウントメニューを表示/隠す</td><td><b>A</b>ccount, <b>M</b>y, <b>M</b>e, <b>M</b>enu</td></tr>
+ <tr><td><kbd class="key">D</kbd></td><td>ダークモード切り替え</td><td><b>D</b>ark</td></tr>
+ <tr><td><kbd class="key">Z</kbd></td><td>上部のバーを隠す</td><td><b>Z</b>en</td></tr>
+ <tr><td><kbd class="key">H</kbd>, <kbd class="key">?</kbd></td><td>ヘルプを表示</td><td><b>H</b>elp</td></tr>
+ </tbody>
+</table>
+
+## 投稿にフォーカスされた状態
+<table>
+ <thead>
+ <tr><th>ショートカット</th><th>効果</th><th>由来</th></tr>
+ </thead>
+ <tbody>
+ <tr><td><kbd class="key">↑</kbd>, <kbd class="key">K</kbd>, <kbd class="group"><kbd class="key">Shift</kbd> + <kbd class="key">Tab</kbd></kbd></td><td>上の投稿にフォーカスを移動</td><td>-</td></tr>
+ <tr><td><kbd class="key">↓</kbd>, <kbd class="key">J</kbd>, <kbd class="key">Tab</kbd></td><td>下の投稿にフォーカスを移動</td><td>-</td></tr>
+ <tr><td><kbd class="key">←</kbd>, <kbd class="key">R</kbd></td><td>返信フォームを開く</td><td><b>R</b>eply</td></tr>
+ <tr><td><kbd class="key">→</kbd>, <kbd class="key">Q</kbd></td><td>Renoteフォームを開く</td><td><b>Q</b>uote</td></tr>
+ <tr><td><kbd class="group"><kbd class="key">Ctrl</kbd> + <kbd class="key">→</kbd></kbd>, <kbd class="group"><kbd class="key">Ctrl</kbd> + <kbd class="key">Q</kbd></kbd></td><td>即刻Renoteする(フォームを開かずに)</td><td>-</td></tr>
+ <tr><td><kbd class="key">E</kbd>, <kbd class="key">A</kbd>, <kbd class="key">+</kbd></td><td>リアクションフォームを開く</td><td><b>E</b>mote, re<b>A</b>ction</td></tr>
+ <tr><td><kbd class="key">0</kbd>~<kbd class="key">9</kbd></td><td>数字に対応したリアクションをする(対応については後述)</td><td>-</td></tr>
+ <tr><td><kbd class="key">M</kbd>, <kbd class="key">O</kbd></td><td>投稿に対するメニューを開く</td><td><b>M</b>ore, <b>O</b>ther</td></tr>
+ <tr><td><kbd class="key">S</kbd></td><td>CWで隠された部分を表示 or 隠す</td><td><b>S</b>how, <b>S</b>ee</td></tr>
+ <tr><td><kbd class="key">Esc</kbd></td><td>フォーカスを外す</td><td>-</td></tr>
+ </tbody>
+</table>
+
+## Renoteフォーム
+<table>
+ <thead>
+ <tr><th>ショートカット</th><th>効果</th><th>由来</th></tr>
+ </thead>
+ <tbody>
+ <tr><td><kbd class="key">Enter</kbd></td><td>Renoteする</td><td>-</td></tr>
+ <tr><td><kbd class="key">Q</kbd></td><td>フォームを展開する</td><td><b>Q</b>uote</td></tr>
+ <tr><td><kbd class="key">Esc</kbd></td><td>フォームを閉じる</td><td>-</td></tr>
+ </tbody>
+</table>
+
+## リアクションフォーム
+デフォルトで「👍」にフォーカスが当たっている状態です。
+<table>
+ <thead>
+ <tr><th>ショートカット</th><th>効果</th><th>由来</th></tr>
+ </thead>
+ <tbody>
+ <tr><td><kbd class="key">↑</kbd>, <kbd class="key">K</kbd></td><td>上のリアクションにフォーカスを移動</td><td>-</td></tr>
+ <tr><td><kbd class="key">↓</kbd>, <kbd class="key">J</kbd></td><td>下のリアクションにフォーカスを移動</td><td>-</td></tr>
+ <tr><td><kbd class="key">←</kbd>, <kbd class="key">H</kbd>, <kbd class="group"><kbd class="key">Shift</kbd> + <kbd class="key">Tab</kbd></kbd></td><td>左のリアクションにフォーカスを移動</td><td>-</td></tr>
+ <tr><td><kbd class="key">→</kbd>, <kbd class="key">L</kbd>, <kbd class="key">Tab</kbd></td><td>右のリアクションにフォーカスを移動</td><td>-</td></tr>
+ <tr><td><kbd class="key">Enter</kbd>, <kbd class="key">Space</kbd>, <kbd class="key">+</kbd></td><td>リアクション確定</td><td>-</td></tr>
+ <tr><td><kbd class="key">0</kbd>~<kbd class="key">9</kbd></td><td>数字に対応したリアクションで確定(対応については後述)</td><td>-</td></tr>
+ <tr><td><kbd class="key">Esc</kbd></td><td>リアクションするのをやめる</td><td>-</td></tr>
+ </tbody>
+</table>
+
+## リアクションと数字キーの対応
+<table>
+ <thead>
+ <tr><th>数字キー</th><th>リアクション</th></tr>
+ </thead>
+ <tbody>
+ <tr><td><kbd class="key">1</kbd></td><td>👍</td></tr>
+ <tr><td><kbd class="key">2</kbd></td><td>❤️</td></tr>
+ <tr><td><kbd class="key">3</kbd></td><td>😆</td></tr>
+ <tr><td><kbd class="key">4</kbd></td><td>🤔</td></tr>
+ <tr><td><kbd class="key">5</kbd></td><td>😮</td></tr>
+ <tr><td><kbd class="key">6</kbd></td><td>🎉</td></tr>
+ <tr><td><kbd class="key">7</kbd></td><td>💢</td></tr>
+ <tr><td><kbd class="key">8</kbd></td><td>😥</td></tr>
+ <tr><td><kbd class="key">9</kbd></td><td>😇</td></tr>
+ <tr><td><kbd class="key">0</kbd></td><td>🍮 or 🍣</td></tr>
+ </tbody>
+</table>
+
+# 例
+<table>
+ <thead>
+ <tr><th>ショートカット</th><th>動作</th></tr>
+ </thead>
+ <tbody>
+ <tr><td><kbd class="key">t</kbd><kbd class="key">+</kbd><kbd class="key">+</kbd></td><td>タイムラインの最新の投稿に👍する</td></tr>
+ <tr><td><kbd class="key">t</kbd><kbd class="key">1</kbd></td><td>タイムラインの最新の投稿に👍する</td></tr>
+ <tr><td><kbd class="key">t</kbd><kbd class="key">0</kbd></td><td>タイムラインの最新の投稿に🍮する</td></tr>
+ </tbody>
+</table>
diff --git a/src/docs/stream.ja-JP.md b/src/docs/stream.ja-JP.md
index c720299932..a8b0eb0cdc 100644
--- a/src/docs/stream.ja-JP.md
+++ b/src/docs/stream.ja-JP.md
@@ -55,7 +55,7 @@ APIへリクエストすると、レスポンスがストリームから次の
```json
{
- type: 'api-res:xxxxxxxxxxxxxxxx',
+ type: 'api:xxxxxxxxxxxxxxxx',
body: {
...
}
@@ -95,7 +95,7 @@ Misskeyは投稿のキャプチャと呼ばれる仕組みを提供していま
```json
{
- type: 'note-updated',
+ type: 'noteUpdated',
body: {
note: {
...
@@ -108,7 +108,7 @@ Misskeyは投稿のキャプチャと呼ばれる仕組みを提供していま
---
-このように、投稿の情報が更新されると、`note-updated`イベントが流れてくるようになります。`note-updated`イベントが発生するのは、以下の場合です:
+このように、投稿の情報が更新されると、`noteUpdated`イベントが流れてくるようになります。`noteUpdated`イベントが発生するのは、以下の場合です:
- 投稿にリアクションが付いた
- 投稿に添付されたアンケートに投票がされた
@@ -153,7 +153,7 @@ Misskeyは投稿のキャプチャと呼ばれる仕組みを提供していま
`body`プロパティの中に、投稿情報が含まれています。
-### `read_all_notifications`
+### `readAllNotifications`
自分宛ての通知がすべて既読になったことを表すイベントです。このイベントを利用して、「通知があることを示すアイコン」のようなものをオフにしたりする等のケースが想定されます。
diff --git a/src/docs/style.styl b/src/docs/style.styl
index b01fe493ac..70d77b5499 100644
--- a/src/docs/style.styl
+++ b/src/docs/style.styl
@@ -128,3 +128,24 @@ pre
> code
display block
padding 16px
+
+kbd.group
+ display inline-block
+ padding 4px
+ background #fbfbfb
+ border 1px solid #d6d6d6
+ border-radius 4px
+ box-shadow 0 1px 1px rgba(0, 0, 0, 0.1)
+
+kbd.key
+ display inline-block
+ padding 6px 8px
+ background #fff
+ border solid 1px #cecece
+ border-radius 4px
+ box-shadow 0 1px 1px rgba(0, 0, 0, 0.1)
+
+td
+ > kbd.group,
+ > kbd.key
+ margin 4px