キーボードショートカットとメニュー選択を記述する¶

ソフトウェアの操作マニュアルやチートシート作成が楽になりそうな記述方法を見つけた。

キーボードショートカットを示す記述と、メニュー選択を示す記述方法。

キーボードショートカットでは、以下の記述をする。

アプリケーションを終了するキーボードショートカットは :kbd:`Command + Q` です。

表示は以下のようになる。

アプリケーションを終了するキーボードショートカットは Command + Q です。

「Command + Q」の部分に淡い色がつく。同じ文書中に繰り返しこの表記が使われる事で読者は地の文とキーボードショートカットの区別を認識しやすくなる効果がある。

同じく、メニュー選択では、以下の記述をする。

アプリケーションを終了するメニューは :menuselection:`File --> Quit` です。

表示は以下のようになる。

アプリケーションを終了するメニューは File ‣ Quit です。

こちらは、より効果的に見える。「File」と「QUit」が地の文とスタイルが異なる事と単語間の三角形がメニュー操作であることを読者に認識させる効果がある。

さらに、csvテーブルの中でも使用可能。以下のようにcsvの中にそのまま書き込める。

.. csv-table:: チートシート見たいな一覧表
    :widths: 25, 75

    "アプリの終了色々", :kbd:`Command + Q`
    "アプリの終了", :menuselection:`File --> Quit`

出力は以下のようになる。tableの細かなレイアウトはテーマファイルなり、styファイルなりを変更すれば好みの物になりそう。

チートシート見たいな一覧表¶
アプリの終了色々	`Command + Q`
アプリの終了	File ‣ Quit

余談ですが、操作マニュアルの巻末にメニューやショートカットの一覧があると便利だと思うんです。操作を覚えるまでは、一覧表を見ながら操作すると上達が早くなるからです。

Comments