summaryrefslogtreecommitdiff
path: root/templates/reference.duck
blob: 0aae96b5f908f30a72b083a0b9489202330dfacd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
@ducktype/1.0
[-] yelp-tmpl-desc Lists or tables of information for quick lookup

= @TITLE@
  [topic .reference version=1.1]

[--
  Recommended statuses: stub incomplete draft outdated review candidate final
  Remove version attributes you don't use.
--]
@revision[version=0.1 docversion=0.1 pkgversion=0.1 date=@DATE@ status=stub]

@credit[author copyright]
  @name @NAME@
  @email @EMAIL@
  @years @YEAR@

[--
  This puts a link to this topic on the index page.
  Change the xref to link it from another guide.
--]
@link[guide >index]

[--
  Think about whether other pages should be in the seealso list.
  The target page will automatically get a seealso link back.
@link[seealso >someotherid]
--]

[--
  Think about whether external resources should be in the seealso
  list. These require a title.
@link[seealso >>http://someurl]
  @title Link title
--]

@desc Write a short page description here.

@keywords comma-separated list, of keywords, for search


Optionally provide introductory text.
Use terms lists, tables, and bullet lists for reference material.


[terms]
. Example terms list (title optional)

- Term 1
* Description

- Term 2
* Terms can have multiple paragraphs.

  [screen]
  Or any other block element.

- Term 3.1
- Term 3.2
* Terms can also have multiple titles.


[table]
. Example table (title optional)

[thead]
[tr]
- Column 1
- Column 2

[tbody]
[tr]
* Row 1, column 1
* Row 1, column 2

[tr]
* Row 2, column 1
* Row 2, column 2


[list]
. Example list (title optional)

* Item 1

* Item 2
  * Subitem 2.1
  * Subitem 2.2

* Item 3