Add-on Social Media Search & Quote: Documentation

Find out more about the add-on Social Media Search in order to search for content in social media and quote these in Sophora.

Table of Contents

Working with the Add-on

The Social Media Search enables editors to search in Twitter and transfer located contents via drag & drop into the text.

You can also paste post URLs into the Sophora copytext to transfer social media entries from Twitter, Facebook, Instagram, YouTube and ScribbleLive.

This is a paid Sophora add-on. For details, please refer to our website.
Sophora Add-on Social Media Search and Quote with Tooltip

The Social Media Search View

The Social Media Search view works like a normal search. You can search for posts by typing in the text field. Either click 'Search' or hit the enter key to perform the search.

Every result has an author, an abstract and an image if available. Hovering over a result with the mouse will open a tooltip with more details. The user can grow the tooltip to inspect the post and its attachments more closely.

To quote a post, the user can drag and drop the entry from the search into a copytext paragraph.

Right clicking on a result will open a context menu which allows the user to either open the profile of the author or the post itself in an external webbrowser.

Sophora Add-on Social Media Search and Quote - open the profile of the author or the post itself

Configuration

Installing the add-on and restarting the DeskClient creates a new configuration document Social Media Search Configuration in Administration/System/Configuration, in which the access tokens and import information for the social media platforms have to be entered.

The access tokens are unique to every user or app (see OAuth). To acquire an access token, an app has to be registered. All platforms offer guides on how to register new apps. These guides are linked below. Example tokens shown here do not work. Tokens work like passwords, so be careful with them. If no access token has been provided, the corresponding social media platform won't be available in the search view.

Please note that the social media platforms limit the amount of search requests that can be performed within a certain time window. For more information about rate limiting refer to the platform's documentation:

Twitter and Facebook
KeyDescriptionExample
TwitterSee https://apps.twitter.com/app/new (need to be logged in)
twitter.access.tokenAccess token for Twitterxvz1evFS4wEEPTGEFPHBog: L8qq9PZyRg6ieKGEKhZolGC0vJWLw8iEJ88DRdyOg
twitter.access.secretSecret for the access tokeneHZ6MWV2RlM0d0VFUFRHRUZQSEJvZzpM
twitter.consumer.keyThe API keyxvz1evFS4wEEPTGEFPHBog
twitter.consumer.secretSecret for the API key
L8qq9PZyRg6ieKGEKhZolGC0vJWLw8iEJ88DRdyOg
FacebookSee https://developers.facebook.com/docs/facebook-login/access-tokens
facebook.access.tokenAccess token for FacebookGn36foSxiUa9htcubwDRNXwRk4YVo0pl
facebook.app.secretThe application secretXCuTplscGIJhLH36F2AMsOSbVmFEuDFY

Import keys (Quote)

The import keys may be added to the Social Media Search Configuration document in order to configure the scripts that create copytext paragraphs to quote posts.

KeyDescriptionExample
Twitter
twitter.import.images.activeIf set to "true", images will be imported and the following configuration parameters become relevant. Default is "false".true
twitter.import.copytextChildnodeNamesName of the copytext child nodes that should be scanned by the script (required).sophora-content:copytext
twitter.import.images.nodetypeImage node type that will be used when creating images.sophora-extension-nt:image
twitter.import.images.refNodetypeImage reference node type that will be used when linking the paragraph to the images.sophora-content-nt:imageref
twitter.import.structureNodeExternalIdExternal ID of the structure node where created images should be located. If both external ID and structure path are given, the external ID will be used. If none are given, the image will be located at the same structure node as its embedding document.c4bb5ef9-b3e1-4e1c-9d7b-2f8fe61e60e7
twitter.import.structurePathPath of the structure node where created images should be located. If both external ID and structure path are given, the external ID will be used. If none are given, the image will be located at the same structure node as its embedding document./demosite/imports
twitter.import.images.idstemId stem for created image documents. Default is "twitter-import-image"twitter-import-image
twitter.import.images.externalIdPrefixPrefix for the external ID of created image documents. Default is "twitter-import-image-"twitter-import-image-
twitter.import.images.propertiesToSetExpressions to fill properties on the created image documents. Available placeholders: $AUTHOR$, $AUTHOR_URL$, $POST_URL$, $DATE$, $TITLE$sophora-extension:caption=$TITLE$
twitter.import.authorimages.idstemId stem for created author image documents. Default is "twitter-import-author-image"twitter-import-author-image
twitter.import.authorimages.externalIdPrefixPrefix for the external ID of created author image documents. Default is "twitter-import-author-image-"twitter-import-author-image-
twitter.import.authorimages.propertiesToSetSame as for "twitter.import.images.propertiesToSet" but used for the creation of author images.sophora-extension:alttext=Autor: $AUTHOR$
Instagram
instagram.import.*Similar to the keys of Twitter.
Facebook
facebook.import.*Similar to the keys of Twitter.
facebook.import.useOEmbedAPIIf set to "true", the post will be imported via the oEmbed API.
Please note: While this option doesn't require an access token and application secret, not all information can be imported however. Specifically the publication date as well as all images of the post (author images included) can't be accessed via this manner. Therefore the facebook.import.images.active setting will have no effect, if the oEmbed API should be used.
Default is "false".
true
YouTube
youtube.import.*Similar to the keys of Twitter.
ScribbleLive
scribbleLive.import.copytextChildnodeNamesName of the copytext child nodes that should be scanned by the script (required).
scribbleLive.default.titleDefault title for the ScribbleLive event that will be used as paragraph property.
scribbleLive.default.themeIdDefault theme-id for the ScribbleLive event that will be used as paragraph property.
scribbleLive.default.heightDefault height for the ScribbleLive event that will be used as paragraph property.

Configuring Drag And Drop Actions

Dragging a social media post from the Social Media Search into the copytext of a story document will create a new paragraph that contains the URL of the dragged post and execute all scripts with the trigger URL dropped into copytext (See Scripting). Since the content is not saved in HTML form, it can be structured the way the scripter sees fit for any kind of delivery.

Contact us for example or default scripts.