Skip to content

introduction-to-tiny-comments.adoc

Latest commit

 

History

History
59 lines (38 loc) · 2.75 KB

introduction-to-tiny-comments.adoc

File metadata and controls

59 lines (38 loc) · 2.75 KB

Introduction to Tiny Comments

Contents

Overview

The Comments plugin provides the ability to start or join a conversation by adding comments to the content within the {productname} editor.

Collaborate on your projects within your content

The Comments plugin provides:

  • A user interface to collaborate on content by creating and replying to comments.

  • A way to control the delete and resolve operations on a comment or comment thread.

Primary Comments functions

The Comments plugin allows the user to perform the following functions:

  • Create a comment

  • Edit a comment

  • Reply to a comment

  • Lookup a comment

  • Resolve a comment thread

  • Delete a comment or comment thread

Interactive example

The following example shows how to configure the Comments plugin in embedded mode. For information on configuring the Comments plugin, see: Comments plugin Modes.

liveDemo::comments-embedded[]

Getting started with the Comments plugin - Selecting a mode

The Comments plugin is available in two modes: Callback mode and Embedded mode.

Callback Mode

This is the default mode for the Comments plugin. This mode is used to store the comments outside the content on a server, such as a database. This mode requires a number of callback functions to handle comment data. For instructions on configuring the Comments plugin in callback mode, see: Configuring the Comments plugin in callback mode

Embedded Mode

This mode stores the comments within the content. No callbacks need to be configured for this mode. For instructions on configuring the Comments plugin in embedded mode, see: Configuring the Comments plugin Comments in embedded mode