1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-10-31 15:16:18 +00:00
TiddlyWiki5/plugins/tiddlywiki/comments
2023-09-26 17:55:01 +01:00
..
above-story.tid Comments plugin: Fix extraneous paragraph in above story area 2019-03-02 16:18:50 +00:00
add-comment-button-actions.tid Comments plugin: Switch to using the list field to attach comments 2018-08-15 13:50:29 +01:00
add-comment-button.tid Missed off fcc5a6e 2018-08-07 21:47:22 +01:00
comments-template.tid Comment plugin: Autofocus new comment edit box 2018-08-22 09:57:31 +01:00
config.tid Comments plugin: several enhancements 2018-08-07 21:37:07 +01:00
EnableFilter.tid First stab at a threaded commenting plugin 2018-06-21 08:36:15 +01:00
filter-all-comments.tid Comments plugin: Switch to using the list field to attach comments 2018-08-15 13:50:29 +01:00
footer-view-template-segment.tid First stab at a threaded commenting plugin 2018-06-21 08:36:15 +01:00
header-view-template-segment.tid Replace various   with tc-small-gap classes (#4926) 2020-10-28 13:13:55 +00:00
plugin.info Improve plugin metadata, and add a "name" field 2019-09-19 13:04:10 +01:00
readme.tid Comments plugin: Switch to using the list field to attach comments 2018-08-15 13:50:29 +01:00
sidebar-segment.tid Comments plugin: several enhancements 2018-08-07 21:37:07 +01:00
sidebar.tid Comments plugin: Switch to using the list field to attach comments 2018-08-15 13:50:29 +01:00
styles.tid Comments plugin should use palette colours 2023-09-26 17:55:01 +01:00
tagsCommentToolbarButton.tid Comments plugin: several enhancements 2018-08-07 21:37:07 +01:00
toolbar-button-cancel.tid Comments plugin: several enhancements 2018-08-07 21:37:07 +01:00
toolbar-button-delete.tid Comments plugin: several enhancements 2018-08-07 21:37:07 +01:00
toolbar-button-edit.tid Comments plugin: several enhancements 2018-08-07 21:37:07 +01:00
toolbar-button-save.tid Comments plugin: several enhancements 2018-08-07 21:37:07 +01:00

title: $:/plugins/tiddlywiki/comments/readme

This plugin provides a simple means for adding threaded comments to tiddlers.

* Click the "add comment" button to make a new comment, and then click the "save" button to save it
* You can comment on a tiddler itself, or add a comment to an existing comment
* The sidebar tab ''Comments'' lists a timeline of all comments
* Comments are attributed to the username stored in the system tiddler [[$:/status/UserName]]
* By default, comments are available on all non-system tiddlers. The ''config'' tab lets you customise which tiddlers can accept comments by specifying a filter extension
* The buttons for adding and editing comments are only available if the system tiddler [[$:/status/IsReadOnly]] is not set to `yes`
* Use the "All comments" option in the $:/AdvancedSearch ''Filter'' tab to see or export all comments

!! Data Model

The data model employed by the comments plugin is very simple:

* Comment tiddlers are identified by the `role` field being set to `comment`
* The `list` field of comment tiddlers lists the tiddlers to which this comment applies
** It is thus possible for a comment to be applied to multiple tiddlers at once
** The links between comments can be preserved when renaming them by using the relink checkbox in the edit template
* The `edit-mode` field of comment tiddlers is set to `yes` to display it in edit mode, or `no` to display it in view mode
* The `saved-text` field is updated when switching to edit mode so that it can be restored if the user cancels