summaryrefslogtreecommitdiff
path: root/share/templates/thread.tmpl
blob: d0c5990a9af8a94cef7ab5d799320d1c197c8af4 (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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
\==[doc]      [2] [\bullet(packed)[\link[\1][\2]]]
\==[program]  [3]
    [\tablerow[\1 \version[\2]] [\release[\2]]
        [\link[https://archives.eyrie.org/software/\3.tar.gz][tar.gz]
        (\link[https://archives.eyrie.org/software/\3.tar.gz.asc]
              [PGP signature])]
        [\link[https://archives.eyrie.org/software/\3.tar.xz][tar.xz]
        (\link[https://archives.eyrie.org/software/\3.tar.xz.asc]
              [PGP signature])]]
\==[download] [3]
    [\1 \version[\2]\break
     \link[https://archives.eyrie.org/software/\3.tar.gz][tar.gz]
     (\link[https://archives.eyrie.org/software/\3.tar.gz.asc]
           [signature])\break
     \link[https://archives.eyrie.org/software/\3.tar.xz][tar.xz]
     (\link[https://archives.eyrie.org/software/\3.tar.xz.asc]
           [signature])\break
    Released \release[\2]]

\heading[[% name %]][software]

\h1[[% name %]]
[% IF quote %]
\quote[% IF quote.text.length < 80 %](short)[% ELSIF quote.broken %](broken)[% END %][

[% indent(quote.text, 4) %]

][[% quote.author %]][[% IF quote.title %][% quote.title %], [% END %][% IF !quote.work || quote.work.match('"') %][% quote.work %][% ELSE %]\cite[[% quote.work %]][% END %][% IF quote.date %], [% quote.date %][% END %]]
[% END %]
\div(sidebar)[
    \h2[Download]

    \download[[% name %]][[% distribution.version %]]
        [[% distribution.section %]/[% distribution.tarname %]-\version[[% distribution.version %]]]
[% IF distribution.packaging.debian.package && !distribution.packaging.debian.personal %]
    \link[https://packages.debian.org/source/sid/[% distribution.packaging.debian.package %]]
         [Debian packages] \break[% END %]
    \link[https://archives.eyrie.org/software/ARCHIVE/[% distribution.tarname %]/]
         [Archive]

    \h2[Documentation]

    \link[readme.html][General overview] \break
    \link[news.html][Change summary][% FOREACH doc IN docs.user %] \break
    \link[[% doc.name %].html][[% doc.title %]][% END %]
[% IF advisories %]
    \h2[Security Advisories]
[% FOREACH advisory IN advisories %]
    \link[security/[% advisory.date %].html]
        [[% advisory.date %]]: [% name %] [% advisory.versions %]\break
[% END %][% END %]
    \h2[Development]
[% FOREACH doc IN docs.developer %]
    \link[[% doc.name %].html][[% doc.title %]] \break[% END %][% IF vcs.github %]
    \link[https://github.com/[% vcs.github %]]
         [GitHub] \break[% END %][% IF support.github %]
    \link[https://github.com/[% support.github %]/issues]
         [Bug tracker] \break[% END %][% IF vcs.type == 'Git' %]
    \link[[% vcs.browse %]]
         [Git repository] \break[% END %][% IF vcs.status.travis %]
    \link[https://travis-ci.org/[% vcs.status.travis %]]
         [Travis-CI] \break[% END %][% IF distribution.cpan %]
    \link[https://metacpan.org/release/[% distribution.cpan %]]
         [MetaCPAN] \break[% END %][% IF vcs.openhub %]
    \link[[% vcs.openhub %]]
         [Open HUB code analysis] \break[% END %][% IF distribution.packaging.debian.package && !distribution.packaging.debian.personal %]
    \link[https://tracker.debian.org/pkg/[% distribution.packaging.debian.package %]]
         [Debian package tracker] \break[% END %]
]
[% IF orphaned %]
\h2[Warning]

\class(alert)[This package is orphaned.]
[% orphaned %]
[% END %]
\h2[Blurb]

[% to_thread(blurb) %]

\h2[Description]

[% to_thread(description) %]

\h2[Requirements]

[% to_thread(requirements) %]
[% IF build.autotools %]
To bootstrap from a Git checkout, or if you change the Automake files and
need to regenerate Makefile.in, you will need Automake
[% build.automake %] or later.  For bootstrap or if you change
configure.ac or any of the m4 files it includes and need to regenerate
configure or config.h.in, you will need Autoconf [% build.autoconf %] or
later.[% IF build.manpages %]  Perl is also required to generate manual
pages from a fresh Git checkout.[% END %][% IF build.bootstrap %]
[% to_thread(build.bootstrap) %][% END %]
[% END %]
\h2[Download]

The distribution:

\table[][
    \program[[% name %]][[% distribution.version %]]
        [[% distribution.section %]/[% distribution.tarname %]-\version[[% distribution.version %]]]
]

An \link[https://archives.eyrie.org/software/ARCHIVE/[% distribution.tarname %]/]
[archive of older releases] is also available.[% IF advisories %]
\class(alert)[Versions older than [% advisories.0.threshold %] have known
security vulnerabilities and should not be used.][% END %]
[% IF distribution.packaging.debian.summary %]
[% IF distribution.packaging.debian.personal %][% to_thread(distribution.packaging.debian.summary) %]
[% ELSE %][% to_thread(distribution.packaging.debian.summary) | trim %][% IF distribution.packaging.debian.summary.match('\n\n') %]

[% ELSE %]  [% END %]See the \link[https://tracker.debian.org/pkg/[%
distribution.packaging.debian.package %]][Debian package tracker] for more
information.

[% END %][% ELSIF distribution.packaging.debian.personal %]
A Debian package [% IF distribution.packaging.debian.package %]([% distribution.packaging.debian.package %]) [% END %]is available from my \link[../debian.html][personal
repository].
[% END %][% IF distribution.cpan %]
[% name %] is available from CPAN as the
\link[https://metacpan.org/release/[% distribution.cpan %]]
[[% distribution.cpan %] distribution].
[% END %]
[% IF distribution.packaging.extra %]
[% to_thread(distribution.packaging.extra) %]
[% END %][% name %] is maintained using the [% vcs.type %] version control
system.  To check out the current development tree, [% IF vcs.github %]see
\link[https://github.com/[% vcs.github %]][GitHub] or [% END %]clone:

\pre[    [% vcs.url %]]

[% IF vcs.github %]Pull requests on GitHub are welcome.  [% END %]You can
also \link[[% vcs.browse %]][browse the current development source].

\h2[Documentation]
[% IF docs.api %]
\div(left)[
    \class(first)[User documentation:]

    \doc[readme.html][README]
    \doc[news.html][Change summary][% FOREACH doc IN docs.user %]
    \doc[[% doc.name %].html][[% doc.title %]][% END %]
    \doc[license.html][License and copyright]
[% IF advisories %]
    Security advisories:
[% FOREACH advisory IN advisories %]
    \doc[security/[% advisory.date %].html]
        [[% advisory.date %]: [% advisory.versions %]][% END %]
[% END %]
    Developer documentation:
[% FOREACH doc IN docs.developer %]
    \doc[[% doc.name %].html][[% doc.title %]][% END %][% IF vcs.github %]
    \doc[https://github.com/[% vcs.github %]]
        [GitHub][% END %][% IF support.github %]
    \doc[https://github.com/[% support.github %]/issues]
        [Bug tracker][% END %][% IF vcs.status.travis %]
    \doc[https://travis-ci.org/[% vcs.status.travis %]]
        [Travis-CI][% END %][% IF vcs.openhub %]
    \doc[[% vcs.openhub %]]
        [Open HUB code analysis][% END %][% IF docs.contrib %]

    Contributed programs:
[% FOREACH doc IN docs.contrib %]
    \doc[[% doc.name %].html][[% doc.title %]][% END %]
[% END %]
]

\div(right)[
    \class(first)[API documentation:]
[% FOREACH doc IN docs.api %]
    \doc[[% doc.name %].html][[% doc.title %]][% END %][% IF docs.extra %]
[% FOREACH section IN docs.extra %]
    [% section.title %]:
[% FOREACH doc IN section.links %]
    \doc[[% doc.name %].html][[% doc.title %]][% END %][% END %][% END %]
]

\h2(after)[License]
[% ELSE %]
User documentation:

\doc[readme.html][README]
\doc[news.html][Change summary][% FOREACH doc IN docs.user %]
\doc[[% doc.name %].html][[% doc.title %]][% END %]
\doc[license.html][License and copyright]
[% IF advisories %]
Security advisories:
[% FOREACH advisory IN advisories %]
\doc[security/[% advisory.date %].html]
    [[% advisory.date %]: [% advisory.versions %]]
[% END %][% END %]
Developer documentation:
[% FOREACH doc IN docs.developer %]
    \doc[[% doc.name %].html][[% doc.title %]][% END %][% IF vcs.github %]
\doc[https://github.com/[% vcs.github %]]
    [GitHub][% END %][% IF support.github %]
\doc[https://github.com/[% support.github %]/issues]
    [Bug tracker][% END %][% IF vcs.status.travis %]
\doc[https://travis-ci.org/[% vcs.status.travis %]]
    [Travis-CI][% END %][% IF vcs.openhub %]
\doc[[% vcs.openhub %]]
    [Open HUB code analysis][% END %]
[% IF docs.contrib %]
Contributed programs:
[% FOREACH doc IN docs.contrib %]
\doc[[% doc.name %].html][[% doc.title %]]
[% END %][% END %]
\h2[License]
[% END %]
The [% name %] package as a whole is covered by the following copyright
and license:

\block[
[% FOREACH copr IN copyrights %]
    Copyright [% copr.years %]
        [% copr.holder %]
[% END %]

[% indent(to_thread(license.text), 4) %]
[% IF license.notices %]
[% indent(to_thread(license.notices), 4) %]
[% END %]
]

Some individual source files are covered by other, compatible licenses.
For complete copyright and license information, see the file
\link[license.html][LICENSE] in the [% name %] source distribution.

\signature