Wikidata:How to create Wikidata Tours/Write

From Wikidata
Jump to navigation Jump to search

Write the tour wiki page

All the text for each step of the tour is stored on a wiki page. In this step you will create the Tour Wiki page in the main Wikidata:Tours folder along with existing live tours. You can use a copy of the Tour Wiki page template linked below to get started This has the required page structure and formatting which matches other tours.

  1. Navigate to the Tour Wiki page template and click the "Edit source" tab (please do not save any edits to this page)
  2. Select all of the page content and copy it to the clipboard
  3. Navigate to the URL https://www.wikidata.org/wiki/Wikidata:Tours/TOUR NAME (where TOUR NAME is your chosen tour name)
  4. Click the "Create source" tab, then paste the content previously copied from the template
  5. Click the "Publish page" button to save the new page


The rest of the instructions on this page explain how to populate the new Wiki page with real content. Make sure you regularly refer back to the outline created in the previous step, as this will guide the overall flow of your tour as you work through the details.

Structure

  • Step titles: Each "Heading" text section added to the Wiki page will be another step in the tour (this is a 'level 2' heading when using source editor, e.g. == My heading ==). This heading text is used as the title in the pop up for each step.
  • Step content: The text that follows the heading text will be included as the content for that step. This can include any text, templates, images etc that are supported on a normal Wikidata Wiki page.

Add comments to help the JavaScript file creator

You can use comments underneath each section heading to describe how the step should behave. This will help the person who creates the JavaScript file understand you're intentions for each step.

When using visual editor, you can add comments to your wiki page by clicking insert > comments from the menu at the top of the page. In source editor use this notation <!-- comment goes here -->.

The comments should include the following:

  • Element to attach to: Which page element the guide box should attach to, if any. For example, you could write "attach to new statement button", or "attach to property select dropdown". Steps without an attach element will just float in the middle of the page.
  • Action to complete: Here you can describe the user action needed to complete the step, e.g. "Click new statement button", or "select a property". These actions can be used to be used to automatically advance the slide if the user completes the action, as well as to 'auto-complete' the step if the user clicks the "next" button without completing the action themselves. Note that only simple "click" actions are supported for automatic actions at the moment (like a click on a button or linked text), but you should still describe more complex user actions so they can be added as the functionality is expanded (e.g. search and select P21 from the property dropdown).

Tip: When referencing another tour, always link to Wikidata:Tours rather than a specific tour as the item that the tour uses may change which changes the URL. E.g for more information statements, please take the Statements Tour at Wikidata:Tours.