doc: Add title slide meta tags (#165)

rabbit-shocker · Sep 15, 2024 · 95eff38 · 95eff38
1 parent 3bf1af2
commit 95eff38
Show file tree

Hide file tree

Showing 4 changed files with 106 additions and 14 deletions.
diff --git a/doc/en/how-to-make/markdown.md b/doc/en/how-to-make/markdown.md
@@ -40,8 +40,34 @@ title page.
 This example shows the author is Kouhei Sutou and his
 institution is COZMIXNG.
 
-At the moment, you can specify subtitle, content_source and
-even the theme. "theme" is for the default theme of this slide.
+Available attributes are:
+
+* author
+
+* institution
+
+* subtitle
+
+* content_source
+
+* date
+
+* start_time
+
+* end_time
+
+* allotted_time
+
+  The default allotted time in presentation. Used if not
+  specified when starting Rabbit. If both `start_time`
+  and `end_time` are specified, no need to specify
+  `allotted_time` as it will be calculated from those
+  attributes.
+
+* theme
+
+  The default theme of this slide. Used if not specified
+  when starting Rabbit.
 
 ### Emphasis
 

diff --git a/doc/en/how-to-make/rd.rd b/doc/en/how-to-make/rd.rd
@@ -41,8 +41,34 @@ title page.
 This example shows the author is Kouhei Sutou and his
 institution is COZMIXNG.
 
-At the moment, you can specify subtitle, content_source and
-even the theme. "theme" is for the default theme of this slide.
+Available attributes are:
+
+* author
+
+* institution
+
+* subtitle
+
+* content_source
+
+* date
+
+* start_time
+
+* end_time
+
+* allotted_time
+
+  The default allotted time in presentation. Used if not
+  specified when starting Rabbit. If both (({start_time}))
+  and (({end_time})) are specified, no need to specify
+  (({allotted_time})) as it will be calculated from those
+  attributes.
+
+* theme
+
+  The default theme of this slide. Used if not specified
+  when starting Rabbit.
 
 == Image
 

diff --git a/doc/ja/how-to-make/markdown.md b/doc/ja/how-to-make/markdown.md
@@ -43,12 +43,32 @@ title: Markdown記法でのスライドの作り方
 この例では、作者が須藤功平で、所属がCOZMIXNGであるということ
 を示しています。
 
-現在のところ、authorとinstitution以外にsubtitle、
-content_source、themeというメタ情報が指定できます。themeは、
-Rabbitを起動するときにテーマが指定されなかった場合に使用され
-るテーマになります。
+以下の属性が指定可能です:
 
-TODO: 他にもメタデータが増えているはず。
+* author
+
+* institution
+
+* subtitle
+
+* content_source
+
+* date
+
+* start_time
+
+* end_time
+
+* allotted_time
+
+  プレゼンの持ち時間です。Rabbitを起動するときに指定しなかった場合に
+  使用されます。`start_time`と`end_time`を両方指定している
+  場合はそれらの属性から計算されるため、`allotted_time`を指定する
+  必要はありません。
+
+* theme
+
+  テーマです。Rabbitを起動するときに指定しなかった場合に使用されます。
 
 ### 強調
 

diff --git a/doc/ja/how-to-make/rd.rd b/doc/ja/how-to-make/rd.rd
@@ -41,12 +41,32 @@ RDではマークアップの使い方が通常の文書の場合と異なりま
 この例では、作者が須藤功平で、所属がCOZMIXNGであるということ
 を示しています。
 
-現在のところ、authorとinstitution以外にsubtitle、
-content_source、themeというメタ情報が指定できます。themeは、
-Rabbitを起動するときにテーマが指定されなかった場合に使用され
-るテーマになります。
+以下の属性が指定可能です:
 
-TODO: 他にもメタデータが増えているはず。
+* author
+
+* institution
+
+* subtitle
+
+* content_source
+
+* date
+
+* start_time
+
+* end_time
+
+* allotted_time
+
+  プレゼンの持ち時間です。Rabbitを起動するときに指定しなかった場合に
+  使用されます。(({start_time}))と(({end_time}))を両方指定している
+  場合はそれらの属性から計算されるため、(({allotted_time}))を指定する
+  必要はありません。
+
+* theme
+
+  テーマです。Rabbitを起動するときに指定しなかった場合に使用されます。
 
 === 画像