History: PluginRemarksbox
Preview of version: 15
Plugin Remarksbox
Displays a comment, tip, note or warning box
Usage
Copy to clipboard
{REMARKSBOX(type="tip" title="Tip")}remarks text{REMARKSBOX}
Display a comment, tip, note or warning box
Introduced 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
This code shows the four possible types and example titles for each:
Copy to clipboard
{REMARKSBOX(type=>tip|comment|note|warning, title=>Tip|Comment|Note|Warning)}remarks text{REMARKSBOX}
and would provide the following four results (if coded separately):
Comment
remarks text
Confirm
remarks text
Errors
remarks text
Information
remarks text
Note
remarks text
Tip
remarks text
Warning
remarks text