KPimTextEdit

texthtmlbuilder.cpp
1/*
2 SPDX-FileCopyrightText: 2020-2024 Laurent Montel <montel@kde.org>
3 based on code from Stephen Kelly <steveire@gmail.com>
4
5 SPDX-License-Identifier: LGPL-2.0-or-later
6*/
7
8#include "texthtmlbuilder.h"
9
10#include <QDebug>
11#include <QList>
12#include <QTextDocument>
13
14namespace KPIMTextEdit
15{
16class TextHTMLBuilderPrivate
17{
18public:
19 TextHTMLBuilderPrivate(TextHTMLBuilder *b)
20 : q_ptr(b)
21 {
22 }
23
24 QList<QTextListFormat::Style> currentListItemStyles;
25 QString mText;
26
27 TextHTMLBuilder *const q_ptr;
28
29 Q_DECLARE_PUBLIC(TextHTMLBuilder)
30};
31}
32
33using namespace KPIMTextEdit;
34TextHTMLBuilder::TextHTMLBuilder()
35 : AbstractMarkupBuilder()
36 , d_ptr(new TextHTMLBuilderPrivate(this))
37{
38}
39
40TextHTMLBuilder::~TextHTMLBuilder()
41{
42 delete d_ptr;
43}
44
45void TextHTMLBuilder::beginStrong()
46{
47 Q_D(TextHTMLBuilder);
48 d->mText.append(QStringLiteral("<strong>"));
49}
50
51void TextHTMLBuilder::endStrong()
52{
53 Q_D(TextHTMLBuilder);
54 d->mText.append(QStringLiteral("</strong>"));
55}
56
57void TextHTMLBuilder::beginEmph()
58{
59 Q_D(TextHTMLBuilder);
60 d->mText.append(QStringLiteral("<em>"));
61}
62
63void TextHTMLBuilder::endEmph()
64{
65 Q_D(TextHTMLBuilder);
66 d->mText.append(QStringLiteral("</em>"));
67}
68
69void TextHTMLBuilder::beginUnderline()
70{
71 Q_D(TextHTMLBuilder);
72 d->mText.append(QStringLiteral("<u>"));
73}
74
75void TextHTMLBuilder::endUnderline()
76{
77 Q_D(TextHTMLBuilder);
78 d->mText.append(QStringLiteral("</u>"));
79}
80
81void TextHTMLBuilder::beginStrikeout()
82{
83 Q_D(TextHTMLBuilder);
84 d->mText.append(QStringLiteral("<s>"));
85}
86
87void TextHTMLBuilder::endStrikeout()
88{
89 Q_D(TextHTMLBuilder);
90 d->mText.append(QStringLiteral("</s>"));
91}
92
93void TextHTMLBuilder::beginForeground(const QBrush &brush)
94{
95 Q_D(TextHTMLBuilder);
96 d->mText.append(QStringLiteral("<span style=\"color:%1;\">").arg(brush.color().name()));
97}
98
99void TextHTMLBuilder::endForeground()
100{
101 Q_D(TextHTMLBuilder);
102 d->mText.append(QStringLiteral("</span>"));
103}
104
105void TextHTMLBuilder::beginBackground(const QBrush &brush)
106{
107 Q_D(TextHTMLBuilder);
108 d->mText.append(QStringLiteral("<span style=\"background-color:%1;\">").arg(brush.color().name()));
109}
110
111void TextHTMLBuilder::endBackground()
112{
113 Q_D(TextHTMLBuilder);
114 d->mText.append(QStringLiteral("</span>"));
115}
116
117void TextHTMLBuilder::beginAnchor(const QString &href, const QString &name)
118{
119 Q_D(TextHTMLBuilder);
120 if (!href.isEmpty()) {
121 if (!name.isEmpty()) {
122 d->mText.append(QStringLiteral("<a href=\"%1\" name=\"%2\">").arg(href, name));
123 } else {
124 d->mText.append(QStringLiteral("<a href=\"%1\">").arg(href));
125 }
126 } else {
127 if (!name.isEmpty()) {
128 d->mText.append(QStringLiteral("<a name=\"%1\">").arg(name));
129 }
130 }
131}
132
133void TextHTMLBuilder::endAnchor()
134{
135 Q_D(TextHTMLBuilder);
136 d->mText.append(QStringLiteral("</a>"));
137}
138
139void TextHTMLBuilder::beginFontFamily(const QString &family)
140{
141 Q_D(TextHTMLBuilder);
142 d->mText.append(QStringLiteral("<span style=\"font-family:%1;\">").arg(family));
143}
144
145void TextHTMLBuilder::endFontFamily()
146{
147 Q_D(TextHTMLBuilder);
148 d->mText.append(QStringLiteral("</span>"));
149}
150
151void TextHTMLBuilder::beginFontPointSize(int size)
152{
153 Q_D(TextHTMLBuilder);
154 d->mText.append(QStringLiteral("<span style=\"font-size:%1pt;\">").arg(QString::number(size)));
155}
156
157void TextHTMLBuilder::endFontPointSize()
158{
159 Q_D(TextHTMLBuilder);
160 d->mText.append(QStringLiteral("</span>"));
161}
162
163void TextHTMLBuilder::beginParagraph(Qt::Alignment al, qreal topMargin, qreal bottomMargin, qreal leftMargin, qreal rightMargin, bool leftToRightText)
164{
165 Q_D(TextHTMLBuilder);
166 // Don't put paragraph tags inside li tags. Qt bug reported.
167 // if (currentListItemStyles.size() != 0)
168 // {
169 QString styleString;
170 styleString.append(QStringLiteral("margin-top:%1;").arg(topMargin));
171 styleString.append(QStringLiteral("margin-bottom:%1;").arg(bottomMargin));
172 styleString.append(QStringLiteral("margin-left:%1;").arg(leftMargin));
173 styleString.append(QStringLiteral("margin-right:%1;").arg(rightMargin));
174
175 // Using == doesn't work here.
176 // Using bitwise comparison because an alignment can contain a vertical and
177 // a
178 // horizontal part.
179 if (al & Qt::AlignRight) {
180 d->mText.append(QStringLiteral("<p align=\"right\" "));
181 } else if (al & Qt::AlignHCenter) {
182 d->mText.append(QStringLiteral("<p align=\"center\" "));
183 } else if (al & Qt::AlignJustify) {
184 d->mText.append(QStringLiteral("<p align=\"justify\" "));
185 } else if (al & Qt::AlignLeft) {
186 d->mText.append(QStringLiteral("<p"));
187 } else {
188 d->mText.append(QStringLiteral("<p"));
189 }
190 // Bug in grantlee => style is not defined
191 if (!styleString.isEmpty()) {
192 d->mText.append(QStringLiteral(" style=\"") + styleString + QLatin1Char('"'));
193 }
194 if (leftToRightText) {
195 d->mText.append(QStringLiteral(" dir='rtl'"));
196 }
197 d->mText.append(QLatin1Char('>'));
198 // }
199}
200
201void TextHTMLBuilder::beginHeader(int level)
202{
203 Q_D(TextHTMLBuilder);
204 switch (level) {
205 case 1:
206 d->mText.append(QStringLiteral("<h1>"));
207 break;
208 case 2:
209 d->mText.append(QStringLiteral("<h2>"));
210 break;
211 case 3:
212 d->mText.append(QStringLiteral("<h3>"));
213 break;
214 case 4:
215 d->mText.append(QStringLiteral("<h4>"));
216 break;
217 case 5:
218 d->mText.append(QStringLiteral("<h5>"));
219 break;
220 case 6:
221 d->mText.append(QStringLiteral("<h6>"));
222 break;
223 default:
224 break;
225 }
226}
227
228void TextHTMLBuilder::endHeader(int level)
229{
230 Q_D(TextHTMLBuilder);
231 switch (level) {
232 case 1:
233 d->mText.append(QStringLiteral("</h1>"));
234 break;
235 case 2:
236 d->mText.append(QStringLiteral("</h2>"));
237 break;
238 case 3:
239 d->mText.append(QStringLiteral("</h3>"));
240 break;
241 case 4:
242 d->mText.append(QStringLiteral("</h4>"));
243 break;
244 case 5:
245 d->mText.append(QStringLiteral("</h5>"));
246 break;
247 case 6:
248 d->mText.append(QStringLiteral("</h6>"));
249 break;
250 default:
251 break;
252 }
253}
254
255void TextHTMLBuilder::endParagraph()
256{
257 Q_D(TextHTMLBuilder);
258 d->mText.append(QStringLiteral("</p>\n"));
259}
260
261void TextHTMLBuilder::addNewline()
262{
263 Q_D(TextHTMLBuilder);
264 d->mText.append(QStringLiteral("<p>&nbsp;"));
265}
266
267void TextHTMLBuilder::insertHorizontalRule(int width)
268{
269 Q_D(TextHTMLBuilder);
270 if (width != -1) {
271 d->mText.append(QStringLiteral("<hr width=\"%1\" />\n").arg(width));
272 }
273 d->mText.append(QStringLiteral("<hr />\n"));
274}
275
276void TextHTMLBuilder::insertImage(const QString &src, qreal width, qreal height)
277{
278 Q_D(TextHTMLBuilder);
279 d->mText.append(QStringLiteral("<img src=\"%1\" ").arg(src));
280 if (width != 0) {
281 d->mText.append(QStringLiteral("width=\"%2\" ").arg(width));
282 }
283 if (height != 0) {
284 d->mText.append(QStringLiteral("height=\"%2\" ").arg(height));
285 }
286 d->mText.append(QStringLiteral("/>"));
287}
288
289void TextHTMLBuilder::beginList(QTextListFormat::Style type)
290{
291 Q_D(TextHTMLBuilder);
292 d->currentListItemStyles.append(type);
293 switch (type) {
294 case QTextListFormat::ListDisc:
295 d->mText.append(QStringLiteral("<ul type=\"disc\">\n"));
296 break;
297 case QTextListFormat::ListCircle:
298 d->mText.append(QStringLiteral("\n<ul type=\"circle\">\n"));
299 break;
300 case QTextListFormat::ListSquare:
301 d->mText.append(QStringLiteral("\n<ul type=\"square\">\n"));
302 break;
303 case QTextListFormat::ListDecimal:
304 d->mText.append(QStringLiteral("\n<ol type=\"1\">\n"));
305 break;
306 case QTextListFormat::ListLowerAlpha:
307 d->mText.append(QStringLiteral("\n<ol type=\"a\">\n"));
308 break;
309 case QTextListFormat::ListUpperAlpha:
310 d->mText.append(QStringLiteral("\n<ol type=\"A\">\n"));
311 break;
312 case QTextListFormat::ListLowerRoman:
313 d->mText.append(QStringLiteral("\n<ol type=\"i\">\n"));
314 break;
315 case QTextListFormat::ListUpperRoman:
316 d->mText.append(QStringLiteral("\n<ol type=\"I\">\n"));
317 break;
318 default:
319 break;
320 }
321}
322void TextHTMLBuilder::endList()
323{
324 Q_D(TextHTMLBuilder);
325 switch (d->currentListItemStyles.last()) {
326 case QTextListFormat::ListDisc:
327 case QTextListFormat::ListCircle:
328 case QTextListFormat::ListSquare:
329 d->mText.append(QStringLiteral("</ul>\n"));
330 break;
331 case QTextListFormat::ListDecimal:
332 case QTextListFormat::ListLowerAlpha:
333 case QTextListFormat::ListUpperAlpha:
334 case QTextListFormat::ListLowerRoman:
335 case QTextListFormat::ListUpperRoman:
336 d->mText.append(QStringLiteral("</ol>\n"));
337 break;
338 default:
339 break;
340 }
341 d->currentListItemStyles.removeLast();
342}
343void TextHTMLBuilder::beginListItem()
344{
345 Q_D(TextHTMLBuilder);
346 d->mText.append(QStringLiteral("<li>"));
347}
348
349void TextHTMLBuilder::endListItem()
350{
351 Q_D(TextHTMLBuilder);
352 d->mText.append(QStringLiteral("</li>\n"));
353}
354
355void TextHTMLBuilder::beginSuperscript()
356{
357 Q_D(TextHTMLBuilder);
358 d->mText.append(QStringLiteral("<sup>"));
359}
360
361void TextHTMLBuilder::endSuperscript()
362{
363 Q_D(TextHTMLBuilder);
364 d->mText.append(QStringLiteral("</sup>"));
365}
366
367void TextHTMLBuilder::beginSubscript()
368{
369 Q_D(TextHTMLBuilder);
370 d->mText.append(QStringLiteral("<sub>"));
371}
372
373void TextHTMLBuilder::endSubscript()
374{
375 Q_D(TextHTMLBuilder);
376 d->mText.append(QStringLiteral("</sub>"));
377}
378
379void TextHTMLBuilder::beginTable(qreal cellpadding, qreal cellspacing, const QString &width)
380{
381 Q_D(TextHTMLBuilder);
382 d->mText.append(QStringLiteral("<table cellpadding=\"%1\" cellspacing=\"%2\" "
383 "width=\"%3\" border=\"1\">")
384 .arg(cellpadding)
385 .arg(cellspacing)
386 .arg(width));
387}
388
389void TextHTMLBuilder::beginTableRow()
390{
391 Q_D(TextHTMLBuilder);
392 d->mText.append(QStringLiteral("<tr>"));
393}
394
395void TextHTMLBuilder::beginTableHeaderCell(const QString &width, int colspan, int rowspan)
396{
397 Q_D(TextHTMLBuilder);
398 d->mText.append(QStringLiteral("<th width=\"%1\" colspan=\"%2\" rowspan=\"%3\">").arg(width).arg(colspan).arg(rowspan));
399}
400
401void TextHTMLBuilder::beginTableCell(const QString &width, int colspan, int rowspan)
402{
403 Q_D(TextHTMLBuilder);
404 d->mText.append(QStringLiteral("<td width=\"%1\" colspan=\"%2\" rowspan=\"%3\">").arg(width).arg(colspan).arg(rowspan));
405}
406
407void TextHTMLBuilder::endTable()
408{
409 Q_D(TextHTMLBuilder);
410 d->mText.append(QStringLiteral("</table>"));
411}
412
413void TextHTMLBuilder::endTableRow()
414{
415 Q_D(TextHTMLBuilder);
416 d->mText.append(QStringLiteral("</tr>"));
417}
418
419void TextHTMLBuilder::endTableHeaderCell()
420{
421 Q_D(TextHTMLBuilder);
422 d->mText.append(QStringLiteral("</th>"));
423}
424
425void TextHTMLBuilder::endTableCell()
426{
427 Q_D(TextHTMLBuilder);
428 d->mText.append(QStringLiteral("</td>"));
429}
430
431void TextHTMLBuilder::appendLiteralText(const QString &text)
432{
433 Q_D(TextHTMLBuilder);
434 const QString textEscaped = text.toHtmlEscaped();
435 QString textEscapedResult;
436 for (int i = 0, total = textEscaped.length(); i < total; ++i) {
437 const QChar c = textEscaped.at(i);
438
439 if (c == QLatin1Char(' ')) {
440 if (i == 0) {
441 textEscapedResult += QStringLiteral("&nbsp;");
442 } else {
443 if (i + 1 < textEscaped.length() && (textEscaped.at(i + 1) == QLatin1Char(' '))) {
444 textEscapedResult += QStringLiteral("&nbsp;");
445 } else {
446 textEscapedResult += c;
447 }
448 }
449 } else if (c == QLatin1Char('\t')) {
450 textEscapedResult += QStringLiteral("&nbsp;&nbsp;&nbsp; ");
451 } else {
452 textEscapedResult += c;
453 }
454 }
455 d->mText.append(textEscapedResult);
456}
457
458void TextHTMLBuilder::appendRawText(const QString &text)
459{
460 Q_D(TextHTMLBuilder);
461 d->mText.append(text);
462}
463
464QString TextHTMLBuilder::getResult()
465{
466 Q_D(TextHTMLBuilder);
467 auto ret = d->mText;
468 d->mText.clear();
469 return ret;
470}
471
472void KPIMTextEdit::TextHTMLBuilder::addSingleBreakLine()
473{
474 Q_D(TextHTMLBuilder);
475 d->mText.append(QLatin1StringView("<br />"));
476}
KPIMTextEdit::AbstractMarkupBuilder
Interface for creating marked-up text output.
Definition abstractmarkupbuilder.h:37
KPIMTextEdit::TextHTMLBuilder
The TextHTMLBuilder creates a clean html markup output.
Definition texthtmlbuilder.h:86
KPIMTextEdit::TextHTMLBuilder::beginTableCell
void beginTableCell(const QString &width, int colspan, int rowspan) override
Begin a new table cell.
Definition texthtmlbuilder.cpp:401
KPIMTextEdit::TextHTMLBuilder::beginEmph
void beginEmph() override
Begin an emphasised element in the markup.
Definition texthtmlbuilder.cpp:57
KPIMTextEdit::TextHTMLBuilder::beginTable
void beginTable(qreal cellpadding, qreal cellspacing, const QString &width) override
Begin a table element.
Definition texthtmlbuilder.cpp:379
KPIMTextEdit::TextHTMLBuilder::appendRawText
void appendRawText(const QString &text) override
Append text without escaping.
Definition texthtmlbuilder.cpp:458
KPIMTextEdit::TextHTMLBuilder::beginSubscript
void beginSubscript() override
Begin a subscript element.
Definition texthtmlbuilder.cpp:367
KPIMTextEdit::TextHTMLBuilder::beginSuperscript
void beginSuperscript() override
Begin a superscript element.
Definition texthtmlbuilder.cpp:355
KPIMTextEdit::TextHTMLBuilder::beginTableRow
void beginTableRow() override
Begin a new table row.
Definition texthtmlbuilder.cpp:389
KPIMTextEdit::TextHTMLBuilder::endParagraph
void endParagraph() override
Close the paragraph in the markup.
Definition texthtmlbuilder.cpp:255
KPIMTextEdit::TextHTMLBuilder::endSuperscript
void endSuperscript() override
End superscript element.
Definition texthtmlbuilder.cpp:361
KPIMTextEdit::TextHTMLBuilder::getResult
QString getResult() override
Return the fully marked up result of the building process.
Definition texthtmlbuilder.cpp:464
KPIMTextEdit::TextHTMLBuilder::beginAnchor
void beginAnchor(const QString &href={}, const QString &name={}) override
Begin a url anchor element in the markup.
Definition texthtmlbuilder.cpp:117
KPIMTextEdit::TextHTMLBuilder::endStrong
void endStrong() override
Close the bold element in the markup.
Definition texthtmlbuilder.cpp:51
KPIMTextEdit::TextHTMLBuilder::endList
void endList() override
Close the list.
Definition texthtmlbuilder.cpp:322
KPIMTextEdit::TextHTMLBuilder::endAnchor
void endAnchor() override
Close the anchor element.
Definition texthtmlbuilder.cpp:133
KPIMTextEdit::TextHTMLBuilder::beginListItem
void beginListItem() override
Begin a new list item in the markup.
Definition texthtmlbuilder.cpp:343
KPIMTextEdit::TextHTMLBuilder::endTable
void endTable() override
End a table element.
Definition texthtmlbuilder.cpp:407
KPIMTextEdit::TextHTMLBuilder::beginForeground
void beginForeground(const QBrush &brush) override
Begin a decorarated foreground element in the markup (A text color) using brush.
Definition texthtmlbuilder.cpp:93
KPIMTextEdit::TextHTMLBuilder::endBackground
void endBackground() override
Close the decorarated background element in the markup.
Definition texthtmlbuilder.cpp:111
KPIMTextEdit::TextHTMLBuilder::beginBackground
void beginBackground(const QBrush &brush) override
Begin a decorarated background element in the markup (A text background color) using brush.
Definition texthtmlbuilder.cpp:105
KPIMTextEdit::TextHTMLBuilder::appendLiteralText
void appendLiteralText(const QString &text) override
Reimplemented from AbstractMarkupBuilder.
Definition texthtmlbuilder.cpp:431
KPIMTextEdit::TextHTMLBuilder::beginStrikeout
void beginStrikeout() override
Begin a struck out element in the markup.
Definition texthtmlbuilder.cpp:81
KPIMTextEdit::TextHTMLBuilder::beginHeader
void beginHeader(int level) override
Begin a new header element.
Definition texthtmlbuilder.cpp:201
KPIMTextEdit::TextHTMLBuilder::endHeader
void endHeader(int level) override
End a header element.
Definition texthtmlbuilder.cpp:228
KPIMTextEdit::TextHTMLBuilder::beginParagraph
void beginParagraph(Qt::Alignment al=Qt::AlignLeft, qreal topMargin=0.0, qreal bottomMargin=0.0, qreal leftMargin=0.0, qreal rightMargin=0.0, bool leftToRightText=false) override
Begin a new paragraph.
Definition texthtmlbuilder.cpp:163
KPIMTextEdit::TextHTMLBuilder::endTableHeaderCell
void endTableHeaderCell() override
End a table header cell.
Definition texthtmlbuilder.cpp:419
KPIMTextEdit::TextHTMLBuilder::beginTableHeaderCell
void beginTableHeaderCell(const QString &width, int colspan, int rowspan) override
Begin a new table header cell.
Definition texthtmlbuilder.cpp:395
KPIMTextEdit::TextHTMLBuilder::endFontFamily
void endFontFamily() override
End font family element.
Definition texthtmlbuilder.cpp:145
KPIMTextEdit::TextHTMLBuilder::endStrikeout
void endStrikeout() override
Close the struck out element in the markup.
Definition texthtmlbuilder.cpp:87
KPIMTextEdit::TextHTMLBuilder::endFontPointSize
void endFontPointSize() override
End font point size element.
Definition texthtmlbuilder.cpp:157
KPIMTextEdit::TextHTMLBuilder::insertHorizontalRule
void insertHorizontalRule(int width=-1) override
Insert a horizontal rule into the markup.
Definition texthtmlbuilder.cpp:267
KPIMTextEdit::TextHTMLBuilder::endTableCell
void endTableCell() override
End a table cell.
Definition texthtmlbuilder.cpp:425
KPIMTextEdit::TextHTMLBuilder::endForeground
void endForeground() override
Close the decorarated foreground element in the markup.
Definition texthtmlbuilder.cpp:99
KPIMTextEdit::TextHTMLBuilder::insertImage
void insertImage(const QString &src, qreal width, qreal height) override
Insert a new image element into the markup.
Definition texthtmlbuilder.cpp:276
KPIMTextEdit::TextHTMLBuilder::beginStrong
void beginStrong() override
Begin a bold element in the markup.
Definition texthtmlbuilder.cpp:45
KPIMTextEdit::TextHTMLBuilder::beginUnderline
void beginUnderline() override
Begin an underlined element in the markup.
Definition texthtmlbuilder.cpp:69
KPIMTextEdit::TextHTMLBuilder::beginList
void beginList(QTextListFormat::Style type) override
Begin a new list element in the markup.
Definition texthtmlbuilder.cpp:289
KPIMTextEdit::TextHTMLBuilder::beginFontFamily
void beginFontFamily(const QString &family) override
Begin a new font family element in the markup.
Definition texthtmlbuilder.cpp:139
KPIMTextEdit::TextHTMLBuilder::endUnderline
void endUnderline() override
Close the underlined element in the markup.
Definition texthtmlbuilder.cpp:75
KPIMTextEdit::TextHTMLBuilder::beginFontPointSize
void beginFontPointSize(int size) override
Begin a new font point size.
Definition texthtmlbuilder.cpp:151
KPIMTextEdit::TextHTMLBuilder::endTableRow
void endTableRow() override
End a table row.
Definition texthtmlbuilder.cpp:413
KPIMTextEdit::TextHTMLBuilder::endEmph
void endEmph() override
Close the emphasised element in the markup.
Definition texthtmlbuilder.cpp:63
KPIMTextEdit::TextHTMLBuilder::addNewline
void addNewline() override
Add a newline to the markup.
Definition texthtmlbuilder.cpp:261
KPIMTextEdit::TextHTMLBuilder::endSubscript
void endSubscript() override
End subscript element.
Definition texthtmlbuilder.cpp:373
KPIMTextEdit::TextHTMLBuilder::endListItem
void endListItem() override
End the list item.
Definition texthtmlbuilder.cpp:349
QBrush::color
const QColor & color() const const
QColor::name
QString name(NameFormat format) const const
QString::append
QString & append(QChar ch)
QString::at
const QChar at(qsizetype position) const const
QString::isEmpty
bool isEmpty() const const
QString::length
qsizetype length() const const
QString::number
QString number(double n, char format, int precision)
QString::toHtmlEscaped
QString toHtmlEscaped() const const
Qt::Alignment
typedef Alignment
Q_D
Q_D(Todo)
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:20:45 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.