Style Guide and Publishing Practices - yes means yes yes means yes
skip to main content

Style Guide and Publishing Practices

Here’s some notes to help you remember some publishing practices. You are always welcome to get in touch with Sherwin if you have questions.

1. General

  1. Page and post titles use title caps, e.g. “Style Guide”, not “Style guide”
  2. Use headings (h1, h2, h3) to help with readability and scannability. Use headings like an outline. The page title is H1.
  3. Bold text: select some text and click the B icon (actually called a strong tag)
  4. Italicized text: select some text and click the I icon (actually call an em tag: emphasis)
  5. Blockquote: put your cursor in a paragraph and select the quotation mark icon.
  6. bullet points: put your cursor in a line and select the bullet point icon.
  7. numbered points: put your cursor in a line and select the numbered list icon

back to top

2. Uploading, Inserting Images

Images need to load fast in users’ phones, and on their dial up internet service. So crop and compress files. JPGs are good, and so are GIFs.

  1. All images need to have titles and ALT text.
  2. Images should be at least 300px wide and at least 200px high.
  3. Most general use images will be around 800 pixels wide or less. Landscape shaped is generally better.
  4. A good services for cropping, editing and compressing is webresizer.com
  5. A better service for cropping, editing, and applying filters and also compressing, is Pixlr Express .
  6. Photos need to be under 100kb. Under 50kb is even better. Bonus points for images under 25kb.
  7. Post should usually have featured images.
  8. When inserting images into a page or post, do not let the image link to itself or somewhere else. No links on images.
Rainbow pride, flag

This image is 250px (pixels) wide and 147px high.

back to top

3. Feature Images for Pages & Posts

  1. Feature images are images that get uploaded to a particular page or post and are set as the FEATURED IMAGE.
  2. Feature images for pages are short and wide 1200 x 300 pixels. See the Team Page, for example.
  3. Feature images for posts are can be less rectangular (800 x 400) or even square (600×600).
  4. Make sure to compress the feature images so they’re nice and light.
  5. Online tools for editing and compressing include:
    1. Webresizer.com
    2. Pixlr Express
    3. Pixlr Editor

back to top

4. Uploading, Inserting PDFs

PDFs are sometimes large in file size, which is okay. It’s best if they’re as compressed as possible, and you can do this with Adobe Acrobat. But the main point is that you signal the user how large the file size is, and also that it’s a PDF.

  1. Upload a PDF just like uploading a photo to the media library
  2. Make sure you add a description
  3. Make sure you add a title that includes the file type and size. E.g. “Annual Report 2012 (PDF 2.4MB)” or “How to Become a Bronie (PDF 600KB)” or even “Our Team Photos (PDF 8MB)”
  4. Click insert media: what happens is that it wraps the title in a link to the PDF which is stored in the media library (on the web server)

Linking to a PDF is technically just like linking to another page on the web. But because PDFs act different than regular pages, we want to warn users what will happen when they click. Some folks are on mobile, or they hate PDFs, or have limited data or bandwidth, etc.

back to top

5. Writing blog posts

  1. Got to: Posts > New
  2. Add to a single category
  3. Add as many tags as you want
  4. *Slug = end part of the URL (editing optional)
  5. Add featured image > always put title and alt text or insert image into the post (See Adding, Inserting Images)
  6. Don’t forget the Excerpt: descriptive, teaser text
  7. Select an author
  8. Save as Draft, or Publish!

back to top

6. Adding a page

  1. Are you sure you need a new page? Double check. Search. Ask a buddy.
  2. What is the new page title?
  3. What will the new, stable, easy to reference, url be?
  4. Will the new page go in the main menu? A different menu?
  5. What template does this new page need. Default is probably fine. But maybe you want something else?

back to top

7. How to manage the menus

There are several menus. The main menu holds most of the pages.

  1. Find menus from the back end (dashboard): Appearance > Menus
  2. Select the menu you want to edit and drag and drop the pages or edit the menu labels

back to top

8. Making links

    1. Use descriptive anchor text. (avoid saying click here)
    2. Write descriptive link titles, but they’re not required.
    3. Make links into buttons where important calls to action happen. e.g. Contact us or Donate now, etc.
    4. When you make buttons, switch to the TEXT tab in the editor and add the text, class="button_red" to the link.

VSAC is actually <a class="button_red" href="http://vsac.ca/buttons/" target="_blank">VSAC</a>

  1. Avoid making links open in new tabs…. maybe