Difference between revisions of "Community Weaver Wiki Guidelines"

From Community Weaver 3 Help
Jump to navigation Jump to search
Line 35: Line 35:
  
 
When outlining how to navigate to an area of the site, use the greater-than symbol, you can also use the code <code><nowiki>{{gear-icon}}</nowiki></code> in your wiki markup to output the gear icon.
 
When outlining how to navigate to an area of the site, use the greater-than symbol, you can also use the code <code><nowiki>{{gear-icon}}</nowiki></code> in your wiki markup to output the gear icon.
 +
 +
As a general practice, make the text of the item itself '''bold''' and the description (menu, button) as plain text
  
 
A sample path to a visitor would be:
 
A sample path to a visitor would be:
  
* {{gear-icon}} '''> News > Post a news article'''
+
* {{gear-icon}} > '''News''' menu > '''Post a news article''' button
  
 
... for example.
 
... for example.

Revision as of 20:52, 22 April 2019


Headings

The heading determines the size of the heading and its level in the table of contents hierarchy. Use headings as you would an outline, with Heading 1 (above) for main sections, then Heading 2 (below) for subsections. In short - use headings similarly to an outline format.

Heading Technique

Keep it simple. If you need more than two levels of headings on a page, the page should probably be split into multiple pages.

Heading Format

Leave a space at the beginning and end of the heading text for readability

Emphasis

Use emphasis sparingly. The heading levels already provide two different kinds of emphasis. A page with multiple kinds of emphasis looks jumbled.

List elements should be de-emphasized.

Tip: Use a tip where you might put a warning or a note. A tip is positive and non-threatening. Put tips in italics like this one.

Links

Create a link to an existing page instead of inserting duplicate text.

If the page does not yet exist, create the link as a reminder. The link will be red until the page is created.

For ease of maintenance, use piped links instead of redirects.

A heading should not be made a link--this mixed mode is confusing to the member.

Screen Elements

Describe screen elements using words that members will understand. If the screen element is a clickable button, call it a button. If it's a link, call it a link. If it's a text box, call it that.

When outlining how to navigate to an area of the site, use the greater-than symbol, you can also use the code {{gear-icon}} in your wiki markup to output the gear icon.

As a general practice, make the text of the item itself bold and the description (menu, button) as plain text

A sample path to a visitor would be:

  • Gear-icon.png > News menu > Post a news article button

... for example.