Skip to content
waldoj edited this page Mar 20, 2013 · 8 revisions

Placeholder page for writing help text to sprinkle throughout the site.

General ideas

  • Perhaps show slightly different text if the browser provides a third-party referrer? Somebody being dropped into a law probably requires a different explanation than somebody who has navigated there from the home page. Or maybe the display simply changes—the same text is provided, but instead it's more prominent?
  • It would be good to have an option to suppress the display of help information. It could get annoying to somebody well familiar with the site.

Structural unit

At the top, explain what this structural unit is—the idea of a structural unit, where it fits into the hierarchy of all structural units for this code, and what the children are (whether more structural units, individual laws, or both). Of course, never actually use the phrase "structural unit." This is in-line text, not hidden as hover text.

Law

If coming from a third-party referrer: "This is a law that is part of the Code of State, part of the Structure called 'Structure Name.' It is formally identified as '§ 12-345.67', but it has a friendlier title of 'Catch line.' Below is the text of the law. Anywhere that you see the [help icon] symbol, that means that help is available—just pass your mouse over the symbol for details." This text should not be hidden behind an icon, but displayed prominently.

History

Make sure that this text is clear. Do people know what it means to "pass" a law?

Also, this is one of two components named "History." That's obviously no good.

Cross References

It's not at all obvious what these are. Really this should be titled "Laws That Mention This One," but that's obviously unwieldy.

Related Laws

Related how? I know they're textually related, as evaluated by Solr, but a reasonable person would have no idea of that. Maybe "Similar Laws"?

Cite As

The people who need to know what this is for already know, but provide something to make it less puzzling for everybody else. (Or deemphasize it, so that people who don't need it will just ignore it.)

Trust, But Verify

That's titled and described with amusing placeholder text I came up with on a whim on the alpha site, two years ago. There are better ways to indicate to people that it is possible to look at this law at its place of origin.

History

This auto-assembled text is a mess. This needs to be totally rewritten. This is going to vary significantly between implementations, but this needs to have a good template.

Home page

The "Welcome" section needs to explain, in no more than two sentences, what somebody is looking at. Of course, every implementation is liable to change that to their own introduction, but this will establish the template for them to use.

Clone this wiki locally