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

Add documentation about title slide meta tags #165

Merged
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
30 changes: 28 additions & 2 deletions doc/en/how-to-make/markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
30 changes: 28 additions & 2 deletions doc/en/how-to-make/rd.rd
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
30 changes: 25 additions & 5 deletions doc/ja/how-to-make/markdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -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を起動するときに指定しなかった場合に使用されます。

### 強調

Expand Down
30 changes: 25 additions & 5 deletions doc/ja/how-to-make/rd.rd
Original file line number Diff line number Diff line change
Expand Up @@ -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を起動するときに指定しなかった場合に使用されます。

=== 画像

Expand Down