> ## Documentation Index
> Fetch the complete documentation index at: https://doc.lucidworks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# collaborate:bookmark

export const LwTemplate = ({title = "Key questions to get you started", icon = "sparkles", cta = "Powered by Agent Studio", linkHref = "https://lucidworks.com/demo/?utm_source=docs&utm_medium=referral&utm_campaign=docs_cta_ai"}) => {
  const [isLoaded, setIsLoaded] = useState(false);
  useEffect(() => {
    const timer = setTimeout(() => {
      setIsLoaded(true);
    }, 500);
    return () => clearTimeout(timer);
  }, []);
  return <div className="lw-template-container">
      <Card title={title} icon={icon}>
        {isLoaded && <span dangerouslySetInnerHTML={{
    __html: `<lw-template id="a029c1a9-28be-427e-b0e1-5d918920246a"></lw-template
            >`
  }} />}
        <Link href={linkHref} className="agent-studio-link text-left text-gray-600 gap-2 dark:text-gray-400 text-sm font-medium flex flex-row items-center hover:text-primary dark:hover:text-primary-light group-hover:text-primary group-hover:dark:text-primary-light">Powered by Lucidworks Agent Studio</Link>
      </Card>
    </div>;
};

[localhost link]: http://localhost:3000/docs/5/app-studio/reference/tags/lightning.directive.collaborateBookmark

[mintlify link]: https://doc.lucidworks.com/docs/5/app-studio/reference/tags/lightning.directive.collaborateBookmark

[old doc.lw link]: https://doc.lucidworks.com/app-studio/4.2/1098

<LwTemplate />

## Description

Creates a new bookmark.

* If used within a result you will need to add the following workflow
  processor to your platform in order to get the status of the bookmark
  and the number of people who have bookmarked the result

```yaml wrap  theme={"dark"}
workflow:
 twigkit.social.processor.AddBookmarkFactsProcessor
```

## Usage

as element:

```xml wrap  theme={"dark"}
<collaborate:bookmark
       target="{string}"
       title="{string}"
       [topic="{number}"]
       [collection="{string}"]
       [url="{string}"]
       [enable-tooltip="{boolean}"]>
</collaborate:bookmark>
```

#### Parameters

| Param | Type | Details |
| - | - | - |
| target | **string** | A unique identifier for a document that is being bookmarked. Example values: document123 Maximum length: 2083 characters |
| title | **string** | A title for the new bookmark. Example values: Interesting document Maximum length: 4000 characters |
| topic  *(optional)* | **number** | A topic to which the new bookmark should belong. |
| collection  *(optional)* | **string** | The collection to which the target document belongs. |
| url  *(optional)* | **string** | A URL which the new bookmark should link to. Default: the bookmark target, if it is a URL |
| enable-tooltip  *(optional)* | **boolean** | Whether to enable the tooltip (Default:true). |

## Example

#### Source

```xml wrap  theme={"dark"}
<h3 id="example_custom-html">Custom HTML</h3>
<collaborate:bookmark><a styling="button">Bookmark</a></collaborate:bookmark>
<hr/>
<h3 id="example_traditional">Traditional</h3>
<collaborate:bookmark></collaborate:bookmark>
<hr/>
<h3 id="example_without-tooltip">Without Tooltip</h3>
<collaborate:bookmark enable-tooltip="false"></collaborate:bookmark>
```

#### Result

<img src="https://mintcdn.com/lucidworks/_JCWsGwGCZxJia7w/assets/images/app-studio/as-examples/tags/collaborateBookmark.png?fit=max&auto=format&n=_JCWsGwGCZxJia7w&q=85&s=0139d90c73f8510d71a8a05c75c4837b" alt="Result" width="1024" height="354" data-path="assets/images/app-studio/as-examples/tags/collaborateBookmark.png" />


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.