Building step-by-step guides in Drupa(u)l's Drag Race

Create the guide steps

  1. Name each step beginning with the four-letter identifier specific to that guide, e.g. "(ABCD)Step name". Step names need to be short, so make it shorter if you can.
  2. Delete the wellness bubble for now.
  3. Assign each step topic(s) and audience(s).

You'll find the identifiers, topics, and audiences here: https://docs.google.com/spreadsheets/d/1iLl98nd_cb-oT8CiXg64I4oKPGUF8alKcYxK7tEl8Kg/edit?ts=5c82e910#gid=0

  1. Save as published.

Create a guide container

  1. Create a guide container and name the guide (delete "How to" from the title if it has it).
  2. Click Add Guide steps and select your introduction page from the list. (The first page of each guide won't have a step number, so you must always have an intro page first). Click Add Guide step again and select what will be your Step 1. Repeat until you have a list of all your steps in order.

  1. In menu settings, tick Provide a menu link, and give the guide a parent item (sub-landing page or sub-sub…).
  2. Save as published.

Add the content to each step

The introduction should contain:

  • Who this guide is for (and optional who this guide is not for)
  • Overview of timeline  we can't build timelines yet[a]
  • Overview of fees, if any (most won’t need this)
  • Get legal help (suggestion to seek legal advice)

The steps should contain:

  • You’ll need list
  • First thing in each step (excluding intro, and maybe the final step)
  • Format "You'll need" as H3, with the list as bullets below (caps, no punctuation). — still waiting for confirmation on this from Anne (?) who'll be doing design QC[b]
  • Include forms (with a link to the form if blank one is required), money for fees, people (e.g. "Someone to serve your documents on the other person"), etc. See divorce guides for examples.
  • Quick links (optional)
  • Only add quick links if there is relevant supplementary information that doesn't need to be included in the body text. Try not to repeat links that are in the body (this is OR’s rule, not mine).
  • Wellness bubbles

If copying text from Word, check the Source view. Even if you've cleaned the formatting, it'll sometimes carry over weird things.

Pay particular attention to:

  • Headings — they're often wrapped in <a> tags
  • Nested bullets
  • Random non-breaking spaces — &nbsp;
  • Anything that had a comment bubble over it in Word — after you delete the comment in Drupal, there might still be some stray <div> tags and other weird things that you can't see

If you stripped the formatting in Notepad or using Shift Ctrl V, check that content has <p> tags. It doesn't add them automatically.

Formatting

Buttons

A button has to be the only thing on that line.

Link the text you want to be a button first, then apply the button style. Use buttons for CTAs, choices, etc.

Columns

Add columns using the block element drop-down:

Definitions

Definitions are written [define:term to be defined] (with no space between colon and term). If there are a lot in one page, do a find and replace in Word. Find text with the green colour (if taking text directly from the current FLWS) and replace with [define:^&], not bold:

Expanders

Use expanders when:

  • the content is optional or not applicable to everyone — e.g. "If you don't live near a Supreme Court registry" or "If you can't afford your court fees", etc.
  • the user might want to choose to view content from several equal options — "If you get a response" and "If you don't get a response"

In the guides only, you can use them to break up a particularly long step but not too often in one guide.

Headings

While info pages start at H2, headings in guides start at H3 because:

  • the title of the step will be H2
  • the title of the guide (container) will be H1

If copying headings from Word without stripping formatting first, check Source view to make sure the headings aren't wrapped in <a> tags. If it is, you'll see in preview the heading will appear like it's a link:

Links — External

Set external links to open in a new window (target "_blank").

All external URLs need to start with http:// or https:// (not just www)

Make sure the link still works and the hyperlinked words are descriptive.

Links — Internal

Internal links need to be linked to the NODE, not a URL.

Start typing the name of the page into the URL bar and it should come up.

If the page title isn't in the list, the page might:

  • not exist yet
  • be in draft mode
  • have a different name

  1. Check the correct title of the page against these lists:
  1. Search for the title in the Drupal content list.
  2. If it's a draft, publish it and try again.
  3. If it's not there, create a shell page (an empty page) so you can link to it.

Don't set it to open in a new window unless it needs to open in a new window (e.g. links in the "Write an affidavit" and "Write a separation agreement" etc. guides will have to open in new windows or the user will lose their work).

Tips/Important boxes

Format the text using the Styles drop-down in the wysiwyg.

Don't include the word "Tip" and "Important" — can anyone verify we're doing this now?

If you highlight multiple paras or bullets and format them with the Tip/Important style, it’ll wrap each element individually like this:

The easiest way is to first create an empty Tip box, cut the text you want to go inside it, and paste it in the empty box.

Otherwise in HTML view you have to:

  1. Delete the first closing div tag </div> and move it to where you want the box to end.
  2. Wrap any paras that aren't bullets in <p></p>
  3. Delete all other opening and closing div tags from around the bullets

[a]FYI Deb is writing up instructions on how this works should be with you next week

[b]Anne doing design QA on Mar 20-22 so I'll get her to take a look