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.

Sign up for GitHub

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

fix document in EN #588

Merged
merged 3 commits into from
Apr 29, 2016
Merged

fix document in EN #588

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
561a035
fix document in en
takahashim Apr 24, 2016
4155318
write more documents and fix some ja docs
takahashim Apr 29, 2016
2709aa5
fix quickstart, add vertical writing
takahashim Apr 29, 2016
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
12 changes: 4 additions & 8 deletions doc/catalog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,9 @@ You can add parts in body to use `CHAPS` in a hierarchy. You can use both title

(For old version user: there is no `PART`. You write them in `CHAPS`.)

## About version 1.3 or earlier
## About earlier version

You can not use `APPENDIX`. Use `POSTDEF`.
In version 1.x, Re:VIEW use 4 files PREDEF, CHAPS, POSTDEF, PART as catalog files.

## About version 1.2 or earlier

Before version 1.2 or earlier, Re:VIEW use 4 files PREDEF, CHAPS, POSTDEF, PART as catalog files.
So you must use these files instead of catalog.yml when you use these versions of Re:VIEW.

Current Re:VIEW supports both catalog.yml and old catalog files. When there are both files, catalog.yml is used.
You can convert there files with `review-catalog-converter`.
When using it, you should compare with these files and the generated file `catalog.yml`.
14 changes: 11 additions & 3 deletions doc/format.ja.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -283,6 +283,8 @@ V1 --> V6 --|

また、本文中で「図 X.X を見てください」のように図を指定する場合は、インライン命令 `@<img>` を使います。`//image` で指定した識別子を用いて「`@<img>{unixhistory}`」のように記述します（`//image` と `@<img>` でつづりが違うので注意してください）。

### 画像ファイルの探索

図として貼り込む画像ファイルは、次の順序で探索され、最初に発見されたものが利用されます。

```
Expand All @@ -300,6 +302,8 @@ V1 --> V6 --|
* `<id>` は //image[〜] の最初に入れた「〜」のことです（つまり、ID に日本語や空白交じりの文字を使ってしまうと、後で画像ファイル名の名前付けに苦労することになります！）。
* `<ext>` は Re:VIEW が自動で判別する拡張子です。ビルダによってサポートおよび優先する拡張子は異なります。

### インラインの画像挿入

段落途中などに画像を貼り込むには、インライン命令の `@<icon>{識別子}` を使います。ファイルの探索ルールは同じです。

## 番号が振られていない図
Expand Down Expand Up @@ -336,7 +340,7 @@ plot sin(x)

## 表

表は `//table[識別子][キャプション]{ 〜 //}` という記法です。ヘッダと内容を分ける罫線は「`------`」（12個以上の連続する `-` または `=`）を使います。
表は `//table[識別子][キャプション]{ 〜 //}` という記法です。ヘッダと内容を分ける罫線は「`------------`」（12個以上の連続する `-` または `=`）を使います。

表の各列のセル間は「1つ」のタブで区切ります。また、列の先頭セルの「`.`」は削除されるので、先頭文字が「`.`」の場合は「`.`」をもう1つ余計に付けてください。たとえば「`.`」という内容のセルは「`..`」と書きます。

Expand All @@ -362,6 +366,8 @@ DISPLAY X Window Systemのデフォルトディスプレイ

表のセル内でもインライン命令は有効です。

### 複雑な表

現時点では表のセルの結合や、中央寄せ・右寄せなどの表現はできません。

複雑な表については、画像を貼り込む `imgtable` ブロック命令を代わりに使用する方法もあります。`imgtable` の表は通常の表と同じく採番され、インライン命令 `@<table>` で参照できます。
Expand Down Expand Up @@ -645,6 +651,8 @@ Re:VIEW のタグ範囲を超えて何か特別な行を挿入したい場合、
* `@<br>{}` : 段落途中で改行します。濫用は避けたいところですが、表のセル内や箇条書き内などで必要になることもあります。
* `@<uchar>{番号}` : Unicode文字を出力します。引数は16進数で指定します。
* `@<href>{URL}`, `@<href>{URL, 文字表現}` : ハイパーリンクを作成します（後述）。
* `@<icon>{識別子}` : インラインの画像を出力します。
* `@<m>{数式}` : インラインの数式を出力します。
* `@<raw>{|ビルダ|〜}` : 生の文字列を出力します。

## 著者用タグ（プリプロセッサ命令）
Expand Down Expand Up @@ -746,10 +754,10 @@ A,B,C
```
<html>
<head>
<title><%= title %></title>
<title><%= @config["booktitle"] %></title>
</head>
<body>
<%= body %>
<%= @body %>
<hr/>
</body>
</html>
Expand Down
Loading