mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-12-25 09:30:28 +00:00
d1f2c399ce
* Add documentation to various widget messages. The following widget messages now have documentation: * tm-edit-bitmap-operation * tm-edit-text-operation * tm-fold-all-tiddlers * tm-fold-other-tiddlers * tm-fold-tiddler * tm-unfold-all-tiddlers * tm-load-plugin-from-library * tm-load-plugin-library * tm-open-window * tm-scroll * Fixed alignment error.
17 lines
914 B
Plaintext
17 lines
914 B
Plaintext
caption: tm-fold-tiddler
|
|
created: 20160424232749223
|
|
modified: 20160424233102003
|
|
tags: Messages
|
|
title: WidgetMessage: tm-fold-tiddler
|
|
type: text/vnd.tiddlywiki
|
|
|
|
The `tm-fold-tiddler` message folds the tiddler specified in the `param` parameter. It does so by setting the text of a state tiddler to either "<<.value "show">>" or "<<.value "hide">>", according to the fold state.
|
|
|
|
|!Name |!Description |
|
|
|param|Title of the tiddler that should be folded. If the tiddler is already folded, it will be unfolded instead. |
|
|
|foldedStatePrefix |Prefix for the state tiddler in which the fold state is stored. If no state prefix is provided, `tm-fold-tiddler` will do nothing. |
|
|
|
|
<<.tip "The core uses a foldStatePrefix of '$:/state/folded/' to store the fold states for the default story view.">>
|
|
|
|
The `tm-fold-tiddler` message is usually generated with the ButtonWidget and is handled by the surrounding NavigatorWidget.
|