TOC

RFC2629 basis sample | J. Reschke
| greenbytes
| March 31, 2010

#
Basic Test Cases for RFC2629 Formatting

### Table of Contents

TOC

### 1. Lists

TOC

### 1.1. hanging list

> Name:
>   timeout
> Namespace:
>   DAV:
> Purpose:
>   The timeout associated with a lock
> Value:
>   TimeType ;Defined in section 9.8

TOC

### 1.2. numbered list

A numbered list:

1. one
2. two
3. three

TOC

### 1.3. ordered list (letters)

An ordered list using letters:

> a.
>   one
> b.
>   two
> c.
>   three
> d.
>   one
> e.
>   two
> f.
>   three
> g.
>   one
> h.
>   two
> i.
>   three
> j.
>   one
> k.
>   two
> l.
>   three
> m.
>   one
> n.
>   two
> o.
>   three
> p.
>   one
> q.
>   two
> r.
>   three
> s.
>   one
> t.
>   two
> u.
>   three
> v.
>   one
> w.
>   two
> x.
>   three
> y.
>   one
> z.
>   two
> aa.
>   three
> ab.
>   one
> ac.
>   two
> ad.
>   three

TOC

### 1.4. no explicit counters

Example for numbered list with user-defined-format:

> R1:
>   R1
> R2:
>   R2

Another list:

> S1:
>   S1
> S2:
>   S2

Next list should continue counting R's:

> R1:
>   R3
> R2:
>   R4

Same with character-based numbering:

> c-a:
>   c-a
> c-b:
>   c-b

TOC

### 1.5. with explicit counters

A few requirements:

> R1:
>   req R1
> R2:
>   req R2

More requirements:

> R3:
>   req R3
> R4:
>   req R4

A few rules:

> R1:
>   rule R1
> R2:
>   rule R2
> R3:
>   rule R3

Explicit counter with name matching it's format string:

> c-a:
>   c-c
> c-b:
>   c-d

Same, without counter:

> c-a:
>   c-e
> c-b:
>   c-f

TOC

### 1.6. Nested list

1. One
2. Two

   > A.
   >   17
   > B.
   >   42

3. Three

TOC

### 1.7. list without style

> One

> Two

> Three

TOC

### 2. spanx

This is default.

This is emph(asized).

This is strong.

This is `verb(atim)`.

Here is `a carriage return inside` a spanx element.

TOC

### 3. Tables

The list of valid keywords are:

keyword | default | meaning | not aligned
--- | --- | --- | ---
strict | no | try to enforce the ID-nits conventions and DTD validity | a
iprnotified | no | include boilerplate from Section 10.4(d) of [RFC2026] (Bradner, S., “The Internet Standards Process -- Revision 3,” October 1996.) | bb bb
compact | no | when producing a txt/nroff file, try to conserve vertical whitespace | ccc ccc ccc
subcompact | compact | if compact is "yes", then setting this to "no" will make things a little less compact | dddd dddd dddd dddd
needLines | n/a | an integer hint indicating how many contiguous lines are needed at this point in the output | eeeee eeeee eeeee eeeee eeeee
here come empty cells |  |  |

Remember, that as with everything else in XML, keywords and values are case-sensitive.

TOC

### 3.1. no borders

The table below should appear with no borders.

C1 | C2
--- | ---
11 | 12
21 | 22

Table 1: a table with no borders

TOC

### 3.2. borders around headers

The table below should appear with borders just around the headers.

C1 | C2
--- | ---
11 | 12
21 | 22

TOC

### 3.3. example from xml2rc README

So, putting it all together, we have, e.g.,

ttcol #1 | ttcol #2
--- | ---
c #1 | c #2
c #3 | c #4
c #5 | c #6

which is a very simple example.

Table 2

TOC

### 3.4. no column titles

The table below should appear with no titles.

11 | 12
21 | 22

Table 3: a table with no column titles

The table below should appear with column titles (one being non-empty).

FOO |
--- | ---
11 | 12
21 | 22

Table 4: a table with a single column title

TOC

### 3.5. referencing tables

Table 1 (a table with no borders) shows a table with no borders.

The table above (a table with no borders) shows a table with no borders.

TOC

### 3.6. table captions

No anchor, no title

Anchor | Title
--- | ---
- | -

Anchor (not being referenced), no title

Anchor | Title
--- | ---
yes | -

Table 5

No anchor, with title

Anchor | Title
--- | ---
- | "title"

title

Both anchor and title

Anchor | Title
--- | ---
yes | "title"

Table 6: title

TOC

### 3.7. single column

title
1
2

TOC

### 3.8. table alignment

left
1

center
1

right
1

default
1

TOC

### 4. Figures

TOC

### 4.1. with preamble, no title...

with preamble, no title...

      +--+
      |  |
      +--+

TOC

### 4.2. with postamble and title...

      +--+
      |  |
      +--+

with postamble and title...

Figure 1: another figure

The figure above has the title "another figure (another figure)".

TOC

### 4.3. Whitespace handling

Para...

Leading whitespace

    test test (leading ws)

Para...

Trailing whitespace

    test test (trailing ws)

Para...

No whitespace

    test test (no ws)

Para...

TOC

### 4.4. Whitespace around figures

spacing paragraph

    ART

spacing paragraph

preamble, then

    ART

spacing paragraph

    ART

then postamble

spacing paragraph

TOC

### 5. References

TOC

### 5.1. xref with no content

Section 5 (References) is the parent section.

TOC

### 5.2. xref to named <t> element

With content: see first sentence of previous section.

Without content: see Paragraph 1.

TOC

### 5.3. xref to named <t> element inside list

With content: see first element in list below.

> test
>   Test

TOC

### 5.4. xref to named <cref> element

With content: see test comment (No anchor, source given.).

Without content: see Comment comment‑test (No anchor, source given.).

TOC

### 5.5. xref to named <t> element inside list

See last entry in Section 1.3 (ordered list (letters)).

TOC

### 5.6. xref with no auto-formatting

So far we have sections 1 (Lists) ("Lists (Lists)") through 5 (References) ("References (References)").

TOC

### 5.7. xref with content and auto-formatting

This is a subsection of References (References).

TOC

### 5.8. xref with content and 'none' formatting

Here we are referring to RFC 2026 (Bradner, S., “The Internet Standards Process -- Revision 3,” October 1996.), without emitting extra formatting.

Here we are referring to this Section (xref with content and 'none' formatting), without emitting extra formatting.

TOC

### 5.9. eref with no content

See also http://greenbytes.de/tech/webdav. Here's another one that is quite long: http://greenbytes.de/tech/webdav/draft-reschke-rfc3744bis-issues.html#5.7_inherited-acl-set-protected. Does it break properly?

TOC

### 5.10. eref with content

See also greenbytes WebDAV resources.

TOC

### 5.11. iref inside paragraph

This paragraph contains an inline iref.

TOC

### 6. Paragraph formatting

This is the first sentence of the paragraph. This is the second sentence of the paragraph (with two leading blanks). Here's another sentence that was started on a separate line in the input file.

This is the second paragraph.

TOC

### 7. Sections

TOC

### 7.1. Subsection with TOC entry

TOC

### 7.2. Subsection without TOC entry

TOC

### 7.2.1. Sub-subsection with TOC entry

TOC

### 8. Comments

This line contains a few comments. [comment-test] (JRE: No anchor, source given.) This line contains a few comments. [comment1] (Anchor given, no source.) This line contains a few comments. [comment2] (JRE: Both specified.) This line contains a few comments. [anchor37] (No anchor, no source.) This line contains a few comments. [anchor38] (No anchor, no source, but embedded markup:.)http://xml.resource.org This line contains a few comments.

TOC

### 9. Artwork width

This should fit (69 characters plus three spaces of indentation in text output).

    012345678901234567890123456789012345678901234567890123456789012345678

This shouldn't.

    0123456789012345678901234567890123456789012345678901234567890123456789

TOC

### 10. Blank Lines

Just a forced
line break.

One
blank line.

Seven blank lines.

TOC

### 11. Other

TOC

### 11.1. Comments in Text

First sentence (before XML comment, invisible here). Second sentence.

TOC

### 12. References

[RFC2026] | Bradner, S., “The Internet Standards Process -- Revision 3,” BCP 9, RFC 2026, October 1996 (TXT).
[RFC2396] | Berners-Lee, T., Fielding, R., and L. Masinter, “Uniform Resource Identifiers (URI): Generic Syntax,” RFC 2396, August 1998. This RFC will soon be updated, check http://cvs.apache.org/viewcvs.cgi/*checkout*/ietf-uri/rev-2002/rfc2396bis.html for the latest draft. The issues list is at http://cvs.apache.org/viewcvs.cgi/*checkout*/ietf-uri/rev-2002/issues.html.

TOC

### Editorial Comments

anchor37: | No anchor, no source.
anchor38: | No anchor, no source, but embedded markup:.
comment-test: | JRE: No anchor, source given.
comment1: | Anchor given, no source.
comment2: | JRE: Both specified.

TOC

### Index

I |
| inline iref

TOC

### Author's Address

| Julian F. Reschke
| greenbytes GmbH
| Hafenweg 16
| Muenster, NW 48155
| Germany
Email: | julian.reschke@greenbytes.de
URI: | http://greenbytes.de/tech/webdav/