How To
Documentation
    Learn More

      collaborate:bookmark

      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
        workflow:
         twigkit.social.processor.AddBookmarkFactsProcessor
        

      Usage

      as element:
      <collaborate:bookmark
             target="{string}"
             title="{string}"
             [topic="{number}"]
             [collection="{string}"]
             [url="{string}"]
             [enable-tooltip="{boolean}"]
             [tooltip="{string}"]
             [active-tooltip="{string}"]
             [singular-tooltip="{string}"]
             [plural-tooltip="{string}"]>
      </collaborate:bookmark>

      Parameters

      ParamTypeDetails
      targetstring

      A unique identifier for a document that is being bookmarked. Example values: document123 Maximum length: 2083 characters

      titlestring

      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).

      tooltip
      (optional)
      string

      Tool tip for the bookmark link. Default: “Bookmark this?”

      active-tooltip
      (optional)
      string

      Tool tip to show when document has already been bookmarked by the current user. Default: “You have bookmarked this.”

      singular-tooltip
      (optional)
      string

      Tool tip for bookmark statistics when there is a single bookmark. Default: “person has bookmarked this.”

      plural-tooltip
      (optional)
      string

      Tool tip for bookmark statistics when there are multiple bookmarks. Default: “people have bookmarked this.”

      Example

      Source

      
      
      

      Demo