214 lines
3.4 KiB
Groff
214 lines
3.4 KiB
Groff
.SH
|
|
An h1 header
|
|
.LP
|
|
Paragraphs are separated by a blank line.
|
|
.PP
|
|
2nd paragraph. \fIItalic\fR, \fBbold\fR, and \fCmonospace\fR. Itemized lists
|
|
look like:
|
|
.IP "\(bu" 2
|
|
this one
|
|
.if n \
|
|
.sp -1
|
|
.if t \
|
|
.sp -0.25v
|
|
.IP "\(bu" 2
|
|
that one
|
|
.if n \
|
|
.sp -1
|
|
.if t \
|
|
.sp -0.25v
|
|
.IP "\(bu" 2
|
|
the other one
|
|
.LP
|
|
Note that \(em not considering the asterisk \(em the actual text
|
|
content starts at 4-columns in.
|
|
.RS
|
|
.PP
|
|
Block quotes are
|
|
written like so.
|
|
.PP
|
|
They can span multiple paragraphs,
|
|
if you like.
|
|
.RE
|
|
.LP
|
|
Use 3 dashes for an em-dash. Use 2 dashes for ranges (ex., \(lqit\(cqs all
|
|
in chapters 12\(en14\(rq). Three dots \[u2026] will be converted to an ellipsis.
|
|
Unicode is supported. ☺
|
|
.SS
|
|
An h2 header
|
|
.LP
|
|
Here\(cqs a numbered list:
|
|
.IP "1. "
|
|
first item
|
|
.if n \
|
|
.sp -1
|
|
.if t \
|
|
.sp -0.25v
|
|
.IP "2. "
|
|
second item
|
|
.if n \
|
|
.sp -1
|
|
.if t \
|
|
.sp -0.25v
|
|
.IP "3. "
|
|
third item
|
|
.LP
|
|
Note again how the actual text starts at 4 columns in (4 characters
|
|
from the left side). Here\(cqs a code sample:
|
|
.LP
|
|
.EX
|
|
# Let me re-iterate ...
|
|
for i in 1 .. 10 { do-something(i) }
|
|
.EE
|
|
.PP
|
|
As you probably guessed, indented 4 spaces. By the way, instead of
|
|
indenting the block, you can use delimited blocks, if you like:
|
|
.LP
|
|
.EX
|
|
define foobar() {
|
|
print \(dqWelcome to flavor country!\(dq;
|
|
}
|
|
.EE
|
|
.PP
|
|
(which makes copying & pasting easier). You can optionally mark the
|
|
delimited block for Pandoc to syntax highlight it:
|
|
.LP
|
|
.EX
|
|
import time
|
|
# Quick, count to ten!
|
|
for i in range(10):
|
|
# (but not *too* quick)
|
|
time.sleep(0.5)
|
|
print i
|
|
.EE
|
|
.SS
|
|
An h3 header
|
|
.LP
|
|
Now a nested list:
|
|
.IP "1. "
|
|
First, get these ingredients:
|
|
.RS
|
|
.IP "\(bu" 2
|
|
carrots
|
|
.if n \
|
|
.sp -1
|
|
.if t \
|
|
.sp -0.25v
|
|
.IP "\(bu" 2
|
|
celery
|
|
.if n \
|
|
.sp -1
|
|
.if t \
|
|
.sp -0.25v
|
|
.IP "\(bu" 2
|
|
lentils
|
|
.RE
|
|
.IP "2. "
|
|
Boil some water.
|
|
.IP "3. "
|
|
Dump everything in the pot and follow
|
|
this algorithm:
|
|
.LP
|
|
.EX
|
|
find wooden spoon
|
|
uncover pot
|
|
stir
|
|
cover pot
|
|
balance wooden spoon precariously on pot handle
|
|
wait 10 minutes
|
|
goto first step (or shut off burner when done)
|
|
.EE
|
|
.IP
|
|
Do not bump wooden spoon or it will fall.
|
|
.LP
|
|
Notice again how text always lines up on 4-space indents (including
|
|
that last line which continues item 3 above).
|
|
.PP
|
|
Here\(cqs a link to \fBa website\fR <\fIhttp://foo.bar\fR>, to a \fBlocal
|
|
doc\fR <\fIlocal-doc.html\fR>, and to a \fBsection heading in the current
|
|
doc\fR <\fI#an-h2-header\fR>. Here\(cqs a footnote \u\s-31\s+3\d.
|
|
.PP
|
|
Tables can look like this:
|
|
.TS
|
|
tab(|) expand allbox;
|
|
lb lb lb
|
|
l l l.
|
|
T{
|
|
size
|
|
T}|T{
|
|
material
|
|
T}|T{
|
|
color
|
|
T}
|
|
T{
|
|
9
|
|
T}|T{
|
|
leather
|
|
T}|T{
|
|
brown
|
|
T}
|
|
T{
|
|
10
|
|
T}|T{
|
|
hemp canvas
|
|
T}|T{
|
|
natural
|
|
T}
|
|
T{
|
|
11
|
|
T}|T{
|
|
glass
|
|
T}|T{
|
|
transparent
|
|
T}
|
|
.TE
|
|
.LP
|
|
Table: Shoes, their sizes, and what they\(cqre made of
|
|
.PP
|
|
(The above is the caption for the table.)
|
|
.PP
|
|
A horizontal rule follows.
|
|
.LP
|
|
\l'2i'
|
|
.LP
|
|
Here\(cqs a definition list:
|
|
.LP
|
|
apples
|
|
.if n \
|
|
.sp -1v
|
|
.if t \
|
|
.sp -0.25v
|
|
.IP "" \*(PI
|
|
Good for making applesauce.
|
|
.LP
|
|
oranges
|
|
.if n \
|
|
.sp -1v
|
|
.if t \
|
|
.sp -0.25v
|
|
.IP "" \*(PI
|
|
Citrus!
|
|
.LP
|
|
tomatoes
|
|
.if n \
|
|
.sp -1v
|
|
.if t \
|
|
.sp -0.25v
|
|
.IP "" \*(PI
|
|
There\(cqs no \(lqe\(rq in tomatoe.
|
|
.LP
|
|
Again, text is indented 4 spaces. (Put a blank line between each
|
|
term/definition pair to spread things out more.)
|
|
.PP
|
|
Images can be specified like so:
|
|
.PP
|
|
\fBexample image\fR (Image: \fIexample-image.jpg\fR)
|
|
.PP
|
|
And note that you can backslash-escape any punctuation characters
|
|
which you wish to be displayed literally, ex.: \(gafoo\(ga, *bar*, etc.
|
|
.LP
|
|
.sp 3
|
|
\l'2i'
|
|
.LP
|
|
\0\fI\u\s-31\s+3\d\fP\0Footnote text goes here.
|