Difference between revisions of "Modèle:Documentation"

From Wazeopedia
(pages moved - fixing wikilinks)
m (14 révisions importées)
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].}}
+
<includeonly><!--
 
+
  Automatically add {{template sandbox notice}} when on a /sandbox page.
<big>'''This script will be included soon.'''</big>
+
-->{{#ifeq: {{SUBPAGENAME}} | sandbox |
----
+
<div style="clear:both" />
[[File:Slackunlock sidebar.png|294px × 475px|framed|right|Sidebar Integration]]
+
{{Template sandbox notice|{{{livepage|}}}}}
 
+
}}<!--
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. 
+
   Start of green doc box.
 
+
-->{{Documentation/start box2
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.
+
| preload = {{{preload|}}}<!-- Allow custom preloads -->
===Setup===
+
| heading = {{{heading|¬}}}<!-- Empty but defined means no header -->
----
+
| heading-style = {{{heading-style|}}}
[[File:Slackunlock settings.png||framed|right|Settings panel]]
+
| content = {{{content|}}}
====Slack====
+
| docspace = {{documentation/docspace}}<!-- Some namespaces must have the /doc, /sandbox and /testcases in talk space -->
{{addCode|TODO: create tutorial for integration into Slack.com}}  
+
| 1 = {{{1|}}}<!-- Other docname, if fed -->
====Editor====
+
| lang = {{{lang|}}}
SlackUnlock in editor setup is simple after your administrator has set up a channel to accept unlock requests.
+
| template page = {{documentation/template page}}<!-- The namespace is added in /start box2 -->
* 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
+
   Start load the /doc content:
* Click the save button.
+
  Note: The line break between this comment and the next line is necessary
* Select segments and submit requests!
+
   so an  "=== Heading ===" at start of doc subpage is correctly interpreted.
 
+
-->
====Channels====
+
{{#switch: {{#if:{{{content|}}}|1|0}}{{#if:{{{1|}}}|1|0}}{{#ifexist:{{{1|}}}|1|0}}{{#ifexist:{{Documentation/docspace}}:{{Documentation/template page}}/doc|1|0}}
<!------------------------------------------------------------------------------------------ 
+
| 0000 | 0100 | 0010 | 0101 = <!-- currently no content to transclude -->
   ------------------------------------------------------------------------------------------
+
| 0001 | 0011 = {{ {{Documentation/docspace}}:{{Documentation/template page}}/doc }}
  -- To add a new row, copy the two lines below and paste them in the noted spot in the table
+
| 0110 | 0111 = {{ {{{1|}}} }}
  --  Make sure to replace the text along with the {} brackets
+
| 1000 | 1001 | 1010 | 1011 | 1100 | 1101 | 1110 | 1111 = {{{content|}}}
  ------------------------------------------------------------------------------------------
+
}}<!--
  --------------------------------  COPY BETWEEN HERE  -------------------------------------
+
  End load the /doc content:
 
+
  Note: The line break between this comment and the next line is necessary
|- style="font-size:75%"
+
  so an "=== Heading ===" at end of doc subpage is correctly interpreted.
| {description} || {channel_name} || <nowiki> {url} </nowiki>
+
-->
 
+
{{Documentation/end box2
  -------------------------------------  AND HERE  -----------------------------------------
+
| preload = {{{preload|}}}<!-- Allow custom preloads -->
   ------------------------------------------------------------------------------------------
+
| content = {{{content|}}}
   ------------------------------------------------------------------------------------------>
+
| link box = {{{link box|}}}<!-- So "link box=off" works -->
{| class="wikitable sortable"
+
| docspace = {{Documentation/docspace}}<!-- Some namespaces must have the /doc, /sandbox and /testcases in talk space -->
|-style="font-size:80%"
+
| 1 = {{{1|}}}<!-- Other docname, if fed -->
! Name !! Channel !! URL
+
| lang = {{{lang|}}}
|-style="font-size:75%"
+
| template page = {{Documentation/template page}}<!-- The namespace is added in /end box2 -->
| Virginia Unlock || #unlock || <nowiki> https://hooks.slack.com/services/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 </nowiki>
+
}}<!--
|- style="font-size:75%"
+
  End of green doc box
| SuperMedic Integration ||n/a (testing)|| <nowiki> https://hooks.slack.com/services/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 </nowiki>
+
--></includeonly><noinclude>
<!------------------------------------------------------------------------------------------
+
{{Documentation}}
  ------------------------------------------------------------------------------------------
+
<!-- Add categories and interwikis to the /doc subpage, not here! -->
  ------------------------------  PASTE ABOVE HERE  ----------------------------------------
+
</noinclude>
  ------------------------------------------------------------------------------------------
 
  ------------------------------------------------------------------------------------------>
 
|}
 
{{addCode|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====
 
[[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].}}
 

Revision as of 21:30, 9 May 2016

Documentation icon Template documentation[view] [edit] [history] [purge]

.

The above documentation is transcluded from Modèle:Documentation/doc.
Please add categories to the /doc subpage.
Subpages of this template.