Template:Tour step

From PickiPedia: A knowledge base of bluegrass, old time psychedelic jams, and other public domain music
Jump to navigationJump to search

One step of the guided tour. On the wiki it renders as a readable line; on magenta it is data: the page's trusted revision is parsed by services/tour.py (magenta#393), and each call becomes a card beside the part of the page it names. Edit the Tour and the live tour changes, once a trusted editor has verified the revision. No deploy.

Usage

{{Tour step|at=composer|text=Type here. '''Enter''' sends; Ctrl+Enter is a new line.|needs=signin}}
{{Tour step|at=more-menu|text=Open ⋯ for pin, promote, copy, edit and delete.|try=yes|needs=signin}}

Parameters

  • at — the part of the page the step points at: a data-tour name in magenta's markup (letters, digits, hyphens). Required. A step naming an anchor the page doesn't have is skipped on the live site and listed on the status page, under "The tour".
  • text — a sentence or two. Required. [[Page]] and [[Page|words]] become links to PickiPedia, bold and italic come through; nothing else does: HTML tags such as <code> show as literal text in the overlay, and any template inside is dropped. A bare | splits the call: inside [[...]] it is fine, anywhere else use &#124;.
  • try — yes: the step waits for the visitor to click what it points at, instead of a Next button (driver.js advanceOnClick).
  • needs — who the step is for: signin (any sign-in), key (an SSH-key sign-in), voice (voice enabled), or signedout (only a visitor who isn't signed in). A visitor without it skips the step. Anything else is ignored.

The anchors

The names the page has, as of magenta#393: moods, mood-bar, pins, sign-in, composer, emergents-bar, attach, memo, message-actions, more-menu, todo, search, jump, bell, nav-tidings, nav-polls, faq, user-menu, help, voice-mode. The status page's "The tour" card is the live list: it names steps with no anchor and anchors with no step, both ways.