Plugin Remarks Box
Introduced in Tiki2
Use this wiki plugin to display a comment, tip, note or warning box.
Parameters
Display a comment, tip, note or warning boxIntroduced in Tiki 2.
Go to the source code
Preferences required: wikiplugin_remarksbox
| Parameters | Accepted Values | Description | Default | Since |
|---|---|---|---|---|
| (body of plugin) | remarks text | |||
icon |
text | Enter a custom icon name (from tiki available icon at https://doc.tiki.org/PluginIcon) | 2.0 | |
id |
text | Sets an HTML id for the account. | 14.0 | |
store_cookie |
(blank) y n |
Set whether to remember if the alert is dismissed (not remembered by default).
Requires id and version parameters to be set. |
14.0 | |
title |
text | Label displayed above the remark. | 2.0 | |
title_class |
text | alert-heading h4 | 21.1 | |
version |
text | Sets a version for the alert. If new version, the alert should show up again even
if it was previously dismissed using the store_cookie parameter |
14.0 | |
width |
text | Width (e.g. 100% or 250px - default "") |
4.1 | |
close |
(blank) y n |
Show a close button (not shown by default). | y | 4.0 |
highlight |
(blank) y n |
Use the highlight class for formatting (not used by default). | 2.0 | |
title_tag |
(blank) div h4 |
div | 21.1 | |
type |
(blank) comment confirm errors information note tip warning |
Select type of remarksbox, which determines what icon and style will be displayed | tip | 2.0 |
Examples
Comment
This code:
Copy to clipboard
{REMARKSBOX(type="comment" title="Comment")}remarks text{REMARKSBOX}
Would produce:
Comment
remarks text
Confirm
This code:
Copy to clipboard
{REMARKSBOX(type="confirm" title="Confirm")}remarks text{REMARKSBOX}
Would produce:
Confirm
remarks text
Errors
This code:
Copy to clipboard
{REMARKSBOX(type="errors" title="Errors")}remarks text{REMARKSBOX}
Would produce:
Errors
remarks text
Information
This code:
Copy to clipboard
{REMARKSBOX(type="information" title="Information")}remarks text{REMARKSBOX}
Would produce:
Information
remarks text
Note
This code:
Copy to clipboard
{REMARKSBOX(type="note" title="Note")}remarks text{REMARKSBOX}
Would produce:
Note
remarks text
Tip
This code:
Copy to clipboard
{REMARKSBOX(type="tip", title="Tip")}remarks text{REMARKSBOX}
Would produce:
Tip
remarks text
Warning
This code:
Copy to clipboard
{REMARKSBOX(type="warning" title="Warning")}remarks text{REMARKSBOX}
Would produce:
Warning
remarks text
Miscellaneous with custom icon
This code:
Copy to clipboard
{REMARKSBOX(type="information" title="Miscellaneous" highlight="y" icon="user" close="n" width="250px" store_cookie="n" id="miscellaneous" version="1")}remarks text{REMARKSBOX}
Would produce:
Miscellaneous
remarks text
Custom body (wiki syntax)
You can use wiki syntax to style the content of the remarksbox.
This code:
Copy to clipboard
{REMARKSBOX(type="note" title="Note")}{DIV(type="h3")}Heading h3{DIV}remarks text%%%Another line{REMARKSBOX}
Would produce:
Note
Heading h3
remarks textAnother line