AsciiDoc による新しいハンドブック

第 4 部

Merlin Project ハンドブックの表紙

今週、ようやくまたうまくいきました。カレンダーに作業時間をブロックして確保するという私の計画が功を奏したのです。水曜日には、ほぼ途切れることなく執筆できました。

その過程で、AsciiDoc についていくつか細かな気づきがありましたので、皆さんと共有したいと思います。

ローカライズされたセクション

残念ながら、目次、図一覧、用語集、参考文献などの特定のセクションは翻訳されません。最初のステップは、言語の定義です。

:lang: de

ただ、これだけではまだ不十分です。Asciidoctor に同梱されている特定のファイル(Github のこちら)を読み込む必要があります。

// Include your own path for the attributes:
include::../locale/attributes.adoc[]

そうして初めて、すべての標準セクション名が希望の言語で表示されます。

プログラム名の繰り返し

確かに、基本的に繰り返しは好ましくありません。ですがハンドブックでは、製品名が何度も繰り返されるのは避けられません。そこで私はすぐに変数を一つ用意しました。

:mp: Merlin Project

変数はこのように使います。

Willkommen bei {mp}!

結果:

Merlin Project へようこそ。

さらにおまけです。私は MerlinProject の間に改行しないスペース(ノーブレークスペース)を入れています(BBEdit ではキーの組み合わせ ⌥ + スペースキー です)。こうすれば、プログラム名が改行で分断されることがありません。

メニュー名とキーボードショートカット

ソフトウェアのハンドブックである以上、画面とその操作の説明は欠かせません。ここではもちろん独自の基準を設けて、要素を 斜体太字 で表すこともできます。ですが AsciiDoc には素晴らしい代替手段があります。そのためには、まず特別なスイッチを使って機能を有効にする必要があります。

:experimental:

ちなみに、スイッチの名前は experimental ですが、この機能はすでに十分に確立されています。これについては Dan Allen のコメント をご覧ください。

メニュー項目は特別な記法で書きます。

Ein Klick auf menu:Hilfe[Dynamische Hilfe] startet die Balloon-Hilfe.

結果:

ヘルプ->動的ヘルプ をクリックすると、バルーンヘルプが起動します。

もちろん、メニュー項目の書式はスタイルで調整できます。

ショートカット、つまりキーボードショートカットも同様に機能します。記法は次のとおりです。

kbd:[⌘ + N]

結果:

⌘ + N

HTML エンティティを変数に入れておくと、さらに簡単になります。私は StackExchange で、Apple のコンピュータ向けに重要な HTML エンティティを見つけました。

:commandkey: ⌘
:optionkey: ⌥
:controlkey: ⌃
:shiftkey: ⇧
:enterkey: ⌤
:enterkey: ⌤
:returnkey: ⏎
:deletekey: ⌫
:rightkey: →
:leftkey: ←
:upkey: ↑
:downkey: ↓

これで、入力はこれだけで済みます。

Drücken Sie kbd:[{commandkey} + Q] um ins Wochenende zu starten.

結果:

⌘ + Q を押して週末に入りましょう。

それでは、また来週まで。

続き。AsciiDoc による新しいハンドブック、第 5 部


このブログ記事についてご質問やご意見がございましたら、ぜひフォーラムへのご投稿をお待ちしております。

プロジェクトを計画する、 本当に機能する形で。

プロジェクト計画のためのひとつのアプリ。すべての Apple デバイスでネイティブに動作します。