Community Plugins, Extensions and Tools/ScriptKit/SlackUnlock: Difference between revisions View history

Latest revision as of 14:53, 24 March 2015

This script is still in beta, most of the bugs have been worked out but some may still remain. If there are any issues please post them in this forum or send a PM to SuperMedic.

This script will be included soon.

This tool allows you to submit unlock requests to a specified Slack.com channel from within WME. The tool has been integrated into the sidebar tab when a segment is selected. This allows easy access to submit the selected segment(s) for unlock.

In order to use this tool your Slack.com administrator or owner needs to configure some back end settings and set up a channel to accept slack unlock requests. PM SuperMedic for more information.

Setup

Slack

TODO: create tutorial for integration into Slack.com

Editor

SlackUnlock in editor setup is simple after your administrator has set up a channel to accept unlock requests.

Paste URL from your Slack administrator or owner in the first text box
Type the channel you need to post to in the second box
Click the save button.
Select segments and submit requests!

Channels

Name	Channel	URL
Virginia Unlock	#unlock	https://hooks.slack.com/services/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
SuperMedic Integration	n/a (testing)	https://hooks.slack.com/services/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

If the channels gets too large move to Community Plugins, Extensions and Tools/ScriptKit/SlackUnlock/channels

Usage

SlackUnlock has been integrated into the sidebar that appears when a segment or multiple segments are selected. As segments are selected SlackUnlock collects a list of Segments IDs and creates a Permalink to your current view to post into the Slack channel. Type a comment into the comments box and click "Request Lock"

Single Segment

With a single segment selected SlackUnlock will create and send the message. Your username and current editor level are included so the editor providing the unlock can contact you for further information. The comment box has unlimited characters so you are able to fully explain your reason for needing the segment unlocked.

Multiple Segments

With multiple segments selected SlackUnlock will de-duplicate and sort the segment levels and send the message. This allows editors of multiple levels to help if possible.

Issues

If you enter a comment into the comment box then unselect the segment a change will be registered on the save icon. If you attempt to save without undoing this change your saves will fail.

SuperMedic can be reached by private message.

@@ Line 1: / Line 1: @@
 {{Mbox|type=construction|text=This script is still in beta, most of the bugs have been worked out but some may still remain.  If there are any issues please post them in [https://www.waze.com/forum/viewforum.php?f=819&t=126240 this forum] or send a PM to [https://www.waze.com/forum/ucp.php?i=pm&mode=compose&subject=ScriptKit%20Wiki&username=SuperMedic SuperMedic].}}
-This script will be included soon.
+<big>'''This script will be included soon.'''</big>
+----
+[[File:Slackunlock sidebar.png|294px × 475px|framed|right|Sidebar Integration]]
-This tool allows you to submit unlock requests to a specified Slack.com channel from within WME.  The tool has been integrated into the sidebar tab when a segment is selected.  This allows easy access to submit the selected segment(s) for unlock.  In order to use this tool your Slack.com administrator or owner needs to configure some back end settings.  PM SuperMedic for more information.
+This tool allows you to submit unlock requests to a specified Slack.com channel from within WME.  The tool has been integrated into the sidebar tab when a segment is selected.  This allows easy access to submit the selected segment(s) for unlock.
+In order to use this tool your Slack.com administrator or owner needs to configure some back end settings and set up a channel to accept slack unlock requests.  PM SuperMedic for more information.
 ===Setup===
-[[File:Slackunlock settings.png|294px x 257px|framed|right|Settings]]
+----
+[[File:Slackunlock settings.png||framed|right|Settings panel]]
+====Slack====
+{{addCode|TODO: create tutorial for integration into Slack.com}}
+====Editor====
+SlackUnlock in editor setup is simple after your administrator has set up a channel to accept unlock requests.
+* Paste URL from your Slack administrator or owner in the first text box
+* Type the channel you need to post to in the second box
+* Click the save button.
+* Select segments and submit requests!
+====Channels====
+<!------------------------------------------------------------------------------------------
+  ------------------------------------------------------------------------------------------
+  --  To add a new row, copy the two lines below and paste them in the noted spot in the table
+  --  Make sure to replace the text along with the {} brackets
+  ------------------------------------------------------------------------------------------
+  --------------------------------  COPY BETWEEN HERE  -------------------------------------
+|- style="font-size:75%"
+| {description} || {channel_name} || <nowiki> {url} </nowiki>
+  -------------------------------------  AND HERE  -----------------------------------------
+  ------------------------------------------------------------------------------------------
+  ------------------------------------------------------------------------------------------>
+{| class="wikitable sortable"
+|-style="font-size:80%"
+! Name !! Channel !! URL
+|-style="font-size:75%"
+| Virginia Unlock || #unlock || <nowiki> https://hooks.slack.com/services/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 </nowiki>
+|- style="font-size:75%"
+| SuperMedic Integration ||n/a (testing)|| <nowiki> https://hooks.slack.com/services/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 </nowiki>
+<!------------------------------------------------------------------------------------------
+  ------------------------------------------------------------------------------------------
+  ------------------------------  PASTE ABOVE HERE  ----------------------------------------
+  ------------------------------------------------------------------------------------------
+  ------------------------------------------------------------------------------------------>
+|}
+{{addCode|If the channels gets too large move to [[Community Plugins, Extensions and Tools/ScriptKit/SlackUnlock/channels]]}}
 ===Usage===
-[[File:Slackunlock sidebar.png|294px × 475px|framed|right|Integration]]
+----
-[[File:Slackunlock chat.png|294px × 246px|framed|right|Chat Display]]
+SlackUnlock has been integrated into the sidebar that appears when a segment or multiple segments are selected.  As segments are selected SlackUnlock collects a list of Segments IDs and creates a Permalink to your current view to post into the Slack channel.
+Type a comment into the comments box and click "Request Lock"
+====Single Segment====
+[[File:slackunlock_single_seg.png|100px x 370px|framed|right|Single segment selected]]
+With a single segment selected SlackUnlock will create and send the message. Your username and current editor level are included so the editor providing the unlock can contact you for further information. The comment box has unlimited characters so you are able to fully explain your reason for needing the segment unlocked.
+====Multiple Segments====
+[[File:slackunlock_multi_seg.png|100px x 370px|framed|right|Multiple segments selected]]
+With multiple segments selected SlackUnlock will de-duplicate and sort the segment levels and send the message.  This allows editors of multiple levels to help if possible.
+===Issues===
+----
+If you enter a comment into the comment box then unselect the segment a change will be registered on the save icon.  If you attempt to save without undoing this change your saves will fail.
 {{Mbox|type=mail|style=background:#CFECEC;|text=SuperMedic can be reached by [https://www.waze.com/forum/ucp.php?i=pm&mode=compose&subject=ScriptKit/SlackUnlock%20Wiki&username=SuperMedic private message].}}

Search