Skip to content

Commit

Permalink
more fix
Browse files Browse the repository at this point in the history
  • Loading branch information
takahashim committed Feb 27, 2015
1 parent ba6bcb8 commit 08a1909
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions doc/format.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@ Re:VIEW is based on EWB of ASCII, influenced RD and other Wiki system's syntax.

## Paragraph

Paragraph needs one empty line.
Paragraphs are separated by an empty line.

Usage:

```
This is a paragraph, paragraph,
and paragraph.
Next paragraph is ...
Next paragraph here is ...
```

two empty lines or more are same as one empty line.
Two empty lines or more are same as one empty line.

## Chapter, Section, Subsection (headings)

Expand Down Expand Up @@ -272,7 +272,7 @@ inline reference markup like `@<img>{unixhistory}`.

When you want to use images in paragraph or other inline context, you can use `@<icon>`.

### find image path
### Finding image pathes

The order of finding image is as follows. The first matched one is used.

Expand All @@ -291,7 +291,7 @@ The order of finding image is as follows. The first matched one is used.
* ``<id>`` is the ID of the first argument of `//image`. You should use only printable ASCII characters as ID.
* ``<ext>`` is file extensions of Re:VIEW. They are different by the builder you use.

## images without caption counter
## Images without caption counter

`//indepimage[filename][caption]` makes images without caption counter.
caption is optional.
Expand All @@ -305,7 +305,7 @@ Usage:
Note that there are similar markup `//numberlessimage`, but it is deprecated.


## figures with graph tools
## Figures with graph tools

Re:VIEW generates image files using graph tool with command `//graph[filename][commandname][caption]`. The caption is optional.

Expand Down Expand Up @@ -429,7 +429,7 @@ Usage:
… is the well-known project.(@<bib>{lins})
```

## leed sentences
## Lead sentences

lead sentences are `//lead{ ... //}`.
You can write as `//read{ ... //}`.
Expand Down Expand Up @@ -465,7 +465,7 @@ Usage:

`//linebreak` and `//pagebreak` will be obsoleted.

## comments
## Comments

If you want to write some comments that do not output in the document, you can use comment notation `#@#`.

Expand All @@ -491,7 +491,7 @@ Usage:
@<comment>{TODO}
```

## raw data block
## Raw data block

When you want to write non-Re:VIEW line, use `//raw`.

Expand Down Expand Up @@ -520,7 +520,7 @@ this is a special line.

Note: `//raw` and `@<raw>` may break structured document easily.

## other grammar
## Other syntax

In Re:VIEW, you can add your customized blocks. So you can define
special block for some books.
Expand Down Expand Up @@ -685,7 +685,7 @@ When section has the label, you can use the label.
```


### heading of columns
### Heading of columns

You can refer the heading of a column with `@<column>`.

Expand Down

0 comments on commit 08a1909

Please sign in to comment.