Where does translation fit into plain language? An information-gathering post

Where does translation fit into the plain language process?

What struck me most when rebuilding Supply and Services Canada’s plain language guides (Plain Language: Clear and Simple and Pour un style clair et simple) was that the French guides aren’t simply the English guides, translated. Although both guides teach the same underlying principles—understanding your audience and the purpose of your document; planning and organizing your document before writing; achieving clarity at the word, sentence, and paragraph levels; implementing a design that supports readability; and user testing with your intended audience—the differences in content between these guides drove home that plain language is language specific.

“Well, obviously,” you might be thinking. Different languages have different grammar, syntax, and vocabulary, each rife with opportunities for ambiguity that have to be tackled individually. The French guides, for instance, address appropriate usage of the indefinite pronoun “on” in plain language, which isn’t a consideration in English. Studies have also shown a “language-specific rhetorical bias” when it comes to using (and by extension, tolerating) the passive voice.

What’s more, the audiences are likely to be vastly different. Even within Canada, French and English speakers have different cultural backgrounds, and those who have neither French nor English as their first language are more likely to learn English than French, meaning that publications in English have to be more sensitive to the needs of ESL speakers than those in French to FSL speakers. A document in plain French, if translated into English, may no longer be plain.

So, being a bit of a workflow nerd, I wondered where translation best fits into the plain language process. Translators have complained that translation is often an afterthought, not considered until the document in the source language is complete. In many cases, though, given that the clarity of the source text can determine the quality of the translation, working with a fully polished text makes sense. Yet, the inherent differences in audience would imply that, for documents that we know will be available in more than one language, developing separate texts in parallel, from the outset, would most effectively get the message across. This approach would be a nightmare for translation revisers and designers of bilingual documents, however, and it certainly isn’t the most budget-friendly option. Would the most efficient approach be to translate after plain language editing but before design, then do parallel testing sessions for the source and target languages?

If you or your organization translates plain language documents, tell me—what do you do? How well does your system work, and what would you change?

Now available: Pour un style clair et simple—Guide du formateur

Earlier this year I rebuilt Supply and Services Canada’s eminently useful but out-of-print plain language guides, including the two sixty-page booklets, Plain Language: Clear and Simple and Pour un style clair et simple, as well as the thorough, two-hundred-page Plain Language: Clear and Simple—Trainer’s Guide, which gives trainers the materials they need to run a two-day plain language workshop.

I’d wondered if a French trainer’s guide existed. (My online searches turned up nothing.) Plain language expert Dominique Joseph tracked it down and sent me a copy, which I’ve also rebuilt from scratch. Here is the PDF, free to download. I’ve also uploaded the guide to CreateSpace for anyone wanting to order a hard copy (and for discoverability).

To keep the complete set in one place, I’ve added these links to the original post where I made the guides available.

A million thanks  go to Dominique Joseph for finding this French guide, sending it to me, and carefully proofing the rebuilt file.

Rethinking the block quote

I recently noticed my tendency to skip right over the block quotes in a book I was reading and figured there are probably others who do the same. My brain likely took the diminutive type as a cue that the quote wasn’t as important as the main text—but was this effect what the author intended?

Maybe.

Nonfiction authors use long quotes for one of two main reasons*:

  1. They have made (and would like to highlight) their own point but are using another authoritative source to buttress the argument.
  2. They want to draw special attention to the other source.

*(Be wary of the more disingenuous reason some authors use block quotes: to boost the word count of their manuscript.)

The problem is that, particularly in the second case, the traditional typographic treatments of block quotes may not do justice to the author’s intent.

Typographic styling of block quotes

According to Robert Bringhurst’s The Elements of Typographic Style, “Block quotations can be distinguished from the main text in many ways. For instance: by a change of face (usually from roman to italic), by a change in size (as from 11 pt down to 10 pt or 9 pt), or by indention.” He continues, “Combinations of these methods are often used, but one device is enough.” Bringhurst also advises using a white line or half-line at either end of the block to distinguish it from the main text.

A change from roman to italic can be problematic; as Access Ability: A Practical Handbook on Accessible Graphic Design advises, italics should be used sparingly and only to enhance communication. Long passages in italics can be hard to read, and since block quotes are usually set as blocks because they are too long to be run in, they are almost by definition ill suited to italics. There are typefaces with very readable italic fonts (Minion comes to mind), but in general italics are harder to read than their roman counterparts.

A change (usually a drop) in size can also be problematic: for readers, text in smaller type—think footnotes or back matter—means that the text is less important and can typically be ignored.

Worse are some websites that use greyed out boxes for block quotes. Rather than highlight the text, the screen is a cue to me that what’s in the box is of secondary importance.

Indention of block quotes has an interesting history: During the Baroque and Romantic periods, long quotations featured quotation marks at the beginning of every line (a practice I’m sure readability advocates are glad we’ve done away with). “When these distractions were finally omitted,” wrote Bringhurst, “the space they had occupied was frequently retained.”

Editorial considerations for block quotes

Editors may be able to give some input to the designer about how to style block quotes, but in many cases those kinds of decisions are beyond an editor’s control (particularly for freelancers). How do we minimize the risk that a quote an author wanted to showcase doesn’t get demoted to afterthought status? Here are some questions to consider:

1. What is the author’s purpose for using the quote?

In a lot of texts, particularly academic ones, quotes do play only a supportive role. In those cases, smaller type may be warranted, as a way of keeping attention on the main text.

However, it gets tricky when you work with texts where the author’s motivation for using quotes varies throughout. In those cases, lobby the designer for a neutral approach to styling a block quote, or reconsider using block quotes altogether.

2. Do we really need a block quote?

Is it important for the author to use the entire quote? Or can you refine it to its essence and use a run-in quote, which—if it means the reader will actually read it—may have more of an impact? Take out as much of the filler as you can. Even a shorter block quote would be better; long blocks of text, particularly in small type, are unwelcoming to readers.

3. Can we draw attention to the block quote through emphasis?

When authors add emphasis, either through italics or boldface, to an existing quote (along with a note that they’ve added emphasis), I admit I stop and pay attention. But don’t overuse this device. If it shows up more than once in a manuscript, it may be a good indication that only the emphasized portion of the quote should be used, run in to the main text.

4. Can we consider alternatives to the traditional block quote?

In a book I recently proofread, long quotes were simply set as regular paragraphs with quotation marks. The quotes never spanned more than a paragraph, and there were few of them, so this approach worked well for this particular text.

If the traditional block quote would not serve the text well, consider other options.

5. Can we communicate intent to the designer?

If possible, let the designer know the purpose of the quotes. It would be impractical—not to mention inconsistent, and crazy making for the designer—to set a different style for quotes you want to highlight and those you want to downplay, but communicating the general tenor of the quotes to the designer may yield a design that better suits the author’s text.

Design options for block quotes

1. Indent only

A neutral approach for block quotes is to eschew decreasing the type size or italicizing and simply set it off with indents, with a line space before and after. The indents provide a visual cue that the text is a quote, but the type size suggests to the reader that it’s at least of equal importance to the main text. Keeping roman type retains readability.

2. Consider a complementary but contrasting typeface

If the main body is in serif type, for example, maybe block quotes can be sans serif, of equal size.

3. If the author wants to highlight the quotes, consider making them bigger

Block quotes in larger type than the main text are almost unheard of, but if emphasis is the author’s intent, this option may be worth considering.

When designing block quotes, don’t be afraid to experiment, but use judgment, of course. Deviating too much from standard expectations can make the styling look like a mistake, and overusing any device can lessen its impact and yield an ugly design.

The main takeaway is the importance of communication: talk to the editor or author, and try to ascertain the purpose of the quotes before deciding how to style them.

***

(The irony isn’t lost on me that my WordPress theme’s default is indented italics for block quotes. Only time will tell if I’ll tweak the CSS or if laziness will prevail.)

Senior editors’ unconference (EAC conference 2014)

What better way for senior editors to learn than by talking to other senior editors?

At the EAC conference, I led the senior editors’ unconference session, which was split into two parts. At lunchtime on Saturday, people were invited to come pitch topics for discussion. I wrote them on a flip chart and gave all participants three sticky dots to vote for their favourite topics. (And if we filled the hour with salacious editorial gossip, I figured that would be fine, too.)

After I tallied the votes, the list of topics was as follows:

  1. Marketing
  2. Setting rates
  3. Dealing with a stagnant client base
  4. Workflow best practices; user testing for workflows
  5. Mentorship—in both directions
  6. Usability testing
  7. Achieving buy-in with style guides
  8. Transitioning from print to digital
  9. Finding new professional development opportunities
  10. Getting out of being typecast
  11. SharePoint do’s & don’ts
  12. Working with international clients
  13. Working with subject experts
  14. File management and archiving

“Sr ask same as n00bs??” wondered Adrienne Montgomerie on Twitter. The top topics—marketing, rates—were the same ones that novice editors have to grapple with, but I was determined that this unconference session would unearth new ideas, not just the same old advice.

Everyone was welcome at the Sunday session; you didn’t have to be at the topic-pitching session to participate. The unconference was scheduled for the last time slot of the concurrent sessions, which worked well because people could bring ideas that other sessions they attended hadn’t covered.

Here’s a run-down of what we discussed. (I’ve eliminated the names here because I never got express permission to quote anyone, and some of what we discussed could be considered sensitive or controversial. If you’d like credit, though, by all means let me know.)

Marketing

Because marketing (#1), setting rates (#2), revitalizing your client base (#3), and getting out of being typecast (#10) are very much related, I concatenated those topics so that we could discuss them together.

One editor noted that her marketing strategy was very much non-marketing. She mostly just tells her friends what she’s doing and what she’s interested in doing. Her work and reputation have allowed her to build her business by word of mouth.

One editor has a diverse portfolio, including writing, editing, indexing, and training. When she has enough work of one type but wants more of another, she targets her online presence to the channel she’d like to build.

Not everyone in the room had a website, but those who did thought it was a valuable part of their marketing. A lot of people had LinkedIn profiles, but we seemed to agree that LinkedIn served as a useful secondary verification, not a good primary means of marketing.

Setting rates

Should you post your rates? That point was controversial. One editor pointed out that having a rate sheet that you send out takes away some of the anxiety of quoting rates or negotiating. Another editor has an instant estimator right on her site. One person said that having a rate sheet or a calculator wouldn’t work for her—she has different rates for different clients, and the rates may vary wildly based on the complexity of the material. She always asks for the document or a sample to give an estimate. Whether you charge by the word or hour or project, it all boils down to the same thing—if you’re good at estimating!

Perfect versus good enough?

How much effort should you sink into a project in the quest for perfection? This discussion was interesting: was a sign of a kind of “editorial maturity” the recognition that it never pays to care more than the client? “Some edits we make because they’re needed,” said one editor. “Some things we sneak in to impress other editors.” If a client wouldn’t appreciate the latter, then those changes probably aren’t worth it. One editor said that for a new client, she always strives for perfection, because she’s hoping for repeat business.

Workflows

How do we educate our clients about workflow best practices? The reality is, as one editor pointed out, “the best workflow for an editor isn’t necessarily the best workflow for an organization.” Organizations may have several authors collaborating on a document and many layers of approval. Self-publishers are more likely to have more flexible timelines, but some of them also need a lot of handholding about process. “About half of the work I do is educating self-publishing clients about the publishing process,” said one editor. Another problem with workflow is that a lot of editors who have never worked in house may not realize how the entire production machine works and how they fit into it. The Toronto EAC branch offers a yearly seminar on production editing—perhaps a consideration for other branches as well? Those of us who have worked in house but are now freelance also need to keep on top of developments in production workflow, because “some things are changing in house, and old rules don’t apply.”

Mentorship

What used to be a benefit of working in house was the mentorship you’d get from a senior editor. That system has changed, especially since editorial training programs have become more popular, although we seemed to agree that internships ideally ought to work on a mentorship model. One editor noted that we need mentorship in both directions: we can teach more junior editors editorial skills, while they may be able to teach us the best ways to use newer technologies. Our network, the EAC Listserv, and the Editors’ Association of Earth Facebook page were all cited as excellent sources of advice.

Usability testing

We moved on to usability testing, which is an essential part of the plain language process. We hear about it a lot but don’t necessarily know how to do it. Those who have done usability testing could attest to its value: although as editors we try to stay informed about a host of different topics, we have to remember that we have our own specialized language that others may not understand. It takes only two or three users to identify what the major problems are with your document. Usertesting.com offers online user testing that’s relatively affordable, and they have great packages if you aim to do a lot of testing.

Style guides

How do you achieve buy-in with style guides? Call it quality assurance, said one editor. If you use PerfectIt, you can use it to export a style guide for easy sharing. Also see my post about how to optimize your house style guide.

***

We didn’t have enough time to discuss the remaining topics. Anyone interested in international editing might want to read my summary of a panel discussion on the topic that we had at the EAC-BC branch.

Thanks to all editors who contributed ideas and attended the unconference session. It was a wisdom-fuelled, energizing way to cap off a great conference.

Advanced Acrobatics: Tips and tricks for PDF mark-up—Adrienne Montgomerie (EAC conference 2014)

Are you still proofreading on paper? More and more clients are looking to do away with the printing and couriering costs associated with paper proofs and are asking proofreaders to mark up changes in PDF. Editor, trainer, and volunteer extraordinaire Adrienne Montgomerie showed us how to do this with the tools in the free Adobe Acrobat Reader. Her handout from her session is here, and she’s also compiled a Storify of her session here. Both of these resources are probably more useful than this write-up, but I still wanted to share some of my main takeaways from the talk.

Acrobat (the Standard and Pro versions, which you have to pay for) does have an “edit” function, but that lets you make changes directly to the document. What we’re talking about here is mark-up: using the program’s drawing or annotation tools to mark up changes that have to be made to the native file. Because PDFs are a fixed format that look the same to everyone, they’re ideal for marking up not only proofs of print materials but also websites, presentations, YouTube videos, and anything else you can capture in a screen shot.

Montgomerie uses a stylus and a Wacom tablet, which some people may find more intuitive than a traditional mouse for marking up a proof. “I prefer PDFs to paper,” she said, “because I can blow up the proof to any size. I can move my marks and resize them. I can right-click on my marks and change their properties, including weight and colour.”

“I use in blue in my mark-up,” she continued, “because I think it’s less threatening.”

Two main ways of adding mark-up to a PDF are to use either the drawing tools, where you essentially use an e-pencil to directly emulate the proofreading mark-up you’d make on paper, or Acrobat’s own annotation tools (Comment & Markup), which track your insertions, deletions, replacements, and highlights. Drawing tools are especially handy for marking up graphic novels and screen shots, where the text may not be recognizable. Be aware that for layered text, text selection for the annotation tools isn’t perfect; sometimes Acrobat chooses the wrong layer.

You can add clarifications or instructions to the designer using the Callout tool. Before sending the proof back, you can run a spell check on all of your text boxes; designers can then copy and paste that text into the source file rather than risk introducing errors by rekeying.

Different designers have different preferences, so ask your clients what they’d prefer. Whichever method you choose, all of your changes will be logged in Acrobat’s Comments List. The Comments List is excellent for quality control (especially because some of the annotation mark-up can be hard to see):

  • A designer can check off the checkbox next to each comment once a change has been implemented.
  • You can sort the Comments List by page order, date entered, checkmark status, type, and reviewer. You can also show or hide certain types of comments.
  • If you’ve got only a handful of changes, you can print only those pages with changes, along with their comments, so that the designer doesn’t have to scan through the whole document.
  • The designer can also reply to each comment, allowing for two-way communication. Sometimes a change can’t be made, and the proofreader needs to know about it for the next round of proofing.

Through the Comment & Markup tools, you can also “Attach a File as a Comment,” which is useful for long inserts. Sometimes clients won’t notice these files, though, so Montgomerie will often send them as email attachments as well.

If you’re using the drawing tools, you can make your life easier by creating or downloading a set of stamps that have your most common proofreading marks. Each stamp comes up as one comment, so if you have a caret (^) plus a hyphen (=), say, the designer doesn’t have to wade through both marks as separate comments. (Mind you, if you manage to draw both in quick succession, Acrobat may recognize them as a single mark as well.)

Under the Select & Zoom tools is the Snapshot tool, which lets you isolate a portion of your page. You can also use it to print (File » Print » Print Selection/Selected Graphic) just those isolated sections—handy if you have a tabloid document but a letter-sized printer, for example.

I wondered if anyone had ever used Annotations for Adobe InDesign, which is a plugin that lets a designer accept or reject annotation changes that a proofreader has marked up in a PDF. Nobody in the room seemed to have used it, and I’m still curious about it. (Maybe InCopy has obviated this tool, but not everyone wants to buy or subscribe to InCopy.)

Our changing language: When does wrong become right?—James Harbeck (EAC conference 2014)

“My head literally exploded.”

Does that sentence drive you crazy?

It reflects a change in the usage of “literally”—one that not everyone accepts. The history of English, though, is replete with examples of usages and syntax that were once considered wrong but that we now accept unthinkingly. “Our job as editors is to be bouncers at the door of our texts,” said James Harbeck. We have to decide which changes to our language to let in and which to keep out.

Language changes, said Harbeck, and we take part in that change. We can’t always predict or control how it will change, and we’re usually unaware of how it has changed in the past. Some people fall into what Harbeck calls the “etymological fallacy”—the belief that if a word used to mean something, that must be its true meaning.

Change happens at the word level—as we gain or lose words or parts of words or as words change in meaning or spelling—and at the syntactic level. (Language also changes at the sound level, but those changes don’t affect us as much in editing.) “Change at word level is like getting new books or rearranging them on a shelf,” said Harbeck. “Change to syntax is like rebuilding the shelves.”

Change comes through invention, borrowing, reinterpretation, or gradual shift. But why does it happen?

  • To make life easier: We often find new ways of expressing ourselves that take fewer words or syllables (e.g., “gonna” for “going to”) or that add clarity (e.g., “you all” for the plural “you”).
  • To feel better: “It’s fun,” said Harbeck. “We enjoy wordplay, clever slang, and cute turns of phrase.” We especially like borrowing words about food. “It’s like borrowing something else to eat,” said Harbeck. “Words go in your mouth, just like food.” Slang and jargon also help us build an in-group identity.
  • To control: Because our language use creates in-groups, we inevitably judge other groups based on their language, which can lead to class-based deprecation. “The poor raise pigs and cows; the rich eat porc and boeuf,” said Harbeck. Efforts to control our thoughts through marketing may also introduce new words and syntax into everyday speech. But “The most insidious kind of change is the change that pretends to be preserving the language against change,” Harbeck said. The grand prescriptivist “rules” that define “proper English” are all changes introduced in the last three centuries.
  • Things slip: Words can broaden, narrow, or shift in meaning. “Basic phonological processes can lead to reanalysis of word boundaries,” said Harbeck. And the people who introduce a language change may not be its vectors. For example, marketing invents while consumers carry.

How do we editors decide what to go with? Harbeck suggests we evaluate each situation as follows:

1. What is the change? Really?

Has a word leaped across a word-class boundary to become a different part of speech? Has its meaning changed? Its spelling? Try to pinpoint exactly what has shifted.

2. Where did it come from? When?

“The Oxford English Dictionary is honestly my favourite swimming pool,” said Harbeck. Use the OED online to trace the history of an innovation in English. You can also look at usage manuals, sites like the Language Log, and Google Ngrams, which can give you good historical information.

3. Where is it used? By whom?

Corpora such as the Corpus of Contemporary American English can give you information about collocations, and Google Ngrams can let you see what texts were using them when. Also refer to texts that are similar to the one you’re working on.

4. Who is your text for?

This is where register comes in. Are you writing for the business world? A magazine? A newspaper? An academic journal? Your Twitter followers? “When you’re deciding on register,” said Harbeck, “you’re really estimating your audience’s LCI—Linguistic Crustiness Index.” How will your audience receive and react to the usage?

5. What are the gains and losses?

When you use an expression like “most unique,” what are you gaining, and what are you losing? You are diluting absoluteness, but you may be gaining a way of expressing a quality that a synonym of “unique”—say, “unusual”—may not capture. If a change adds expressive power, it’s worth keeping.

Where is our language going? With the caveat that you can’t necessarily predict how it will change, Harbeck expects the following trends:

  • Greater flexibility in crossing word-class boundaries, which may start out as deliberate play but will seep through to everyday language.
  • Influence from second-language speakers. “Expect Chinese to have a perceptible effect,” said Harbeck.
  • Use of “they” in the singular. “Singular ‘they’ will prevail. The battle is over. They’re picking up the dead bodies right now,” Harbeck said. Expect a clarifying “they all” or “theys” to develop in parallel with “you all” and “youse.”
  • Acceptance of certain kinds of danglers as sentence adverbials.

Beyond the plain language edit—Claire Foley & Tracy Torchetti (EAC conference 2014)

Those of us who work in plain language are intimately familiar with the basic techniques that help us produce clear communications, including using:

  • common words familiar to the intended reader,
  • a conversational style that speaks directly to the audience,
  • active voice whenever appropriate,
  • short sentences,
  • lists,
  • a positive tone, and
  • an effective design that maximizes readability.

But do these techniques go far enough? At the Editors’ Association of Canada conference, plain language experts Claire Foley and Tracy Torchetti raised some specific issues to keep in mind if you aim to make your writing truly plain.

Audience

Using plain language means writing for your audience—but how well do you know them? If you’re writing for Canadians, be aware that:

  • 42% of adult Canadians have low literacy skills
  • 17% of the Canadian population are immigrants
  • 32% of Canadians don’t have English as a first language

As Foley said, “If you’re writing for Canadians, you are writing for ESL speakers.” And not only is Canada’s immigration population growing—so is its aging population. Your audience is diverse, and your communications will need to accommodate their needs, including those of people with different abilities.

Some text may be translated into Braille or sent through text-to-speech software, said Torchetti, and if the text has been clearly written in plain language, it is more likely to be rendered correctly. Otherwise you may end up with verbal gobbledygook.

Language

Writing for your audience means that plain language pushes the boundary of what is acceptable to those who are wedded to grammar. You have to be flexible if you want to craft a message that is appealing and relevant to your readers. When choosing between words, use the more common one; common words aren’t necessarily the shortest, but they’re the most familiar to the reader.

Contractions

Contractions are generally fine—they’re friendly, conversational, and engaging. However, Foley noted that some contractions are easier than others for readers to understand.

Easier contractions include:

  • I’m
  • can’t
  • don’t
  • you’re
  • who’s
  • what’s
  • where’s

Harder contractions include:

  • could’ve
  • will’ve
  • shouldn’t
  • isn’t
  • aren’t
  • weren’t
  • doesn’t
  • didn’t

Verb tenses

Stick to common verb tenses, such as the simple present and simple past. Try not to use other tenses, like the present progressive, in your plain language writing.

The present tense can work well for both present and future situations (for example, “I work tomorrow”), so if possible, eliminate the “will” and use the present.

Whenever possible, use regular rather than irregular verbs in the past tense. If you’ve got a choice between “talked” and “spoke,” for example, opt for the regular “talked,” whose –ed form is a clear cue to all readers that you’re using the past tense.

Phrasal verbs

Phrasal verbs, such as “give up,” “take over,” and “put off,” are idiomatic and aren’t well understood by well understood by audiences with limited English. Avoid these whenever possible.

Punctuation

Good punctuation matters to clear communication, said Torchetti, but use punctuation minimally.

“Any extra punctuation adds clutter to a page,” she said. You can eliminate a lot of that clutter and add clarity simply by avoiding abbreviations like “e.g.” “Besides, said Torchetti, “that’s an abbreviation of a Latin phrase, and Latin has no place in plain language. Period.”

Particularly fussy punctuation marks that you should avoid include:

  • the colon,
  • the semicolon,
  • the asterisk,
  • the ellipsis,
  • footnote symbols, and
  • parentheses.

Struggling readers don’t really understand the function of the colon, so try not to use it in running text. However, most readers now expect a colon to introduce a list, so, even if it’s not grammatically correct, you should include it.

“Banish the semicolon from plain language,” said Torchetti. “Semicolons are a good indication that you should be changing one sentence into two.”

Most people don’t read text in parentheses and, if they do, they can’t easily see its relationship with the rest of the sentence.

Formatting and presentation

“It’s not plain if you’ve just taken care of the text,” said Torchetti.

Struggling readers have trouble navigating a page, whether printed or online, and they can’t scan large chunks of text. Break up the text into shorter paragraphs, with plenty of white space on the page, and use meaningful titles, headings, and subheadings, which serve as signposts to guide readers. For those headings, though, use sentence case rather than title case, which can be hard to read.

Choose your fonts carefully: script fonts, for example, are hard to read, and older readers need at least a 14-point type size to read comfortably.

The layout should make the information easy to find and use. Visuals should make concepts easier to understand: illustrations that are metaphorical will confuse struggling readers, so make your images informative.

For online information, make it easy for people to navigate and go back. Avoid putting too much information on a page, and make links obvious. In the name of elegance, too many websites now make their links too hard to discern from the rest of text.

Foley and Torchetti recommend Access Ability: A Practical Handbook on Accessible Graphic Design for tips on effective design for audiences with different abilities.

Readability

For a general audience in Canada, readability best practice is to aim for an average reading level of grade 8 for print and grade 6 to 8 for web, although you should adjust your reading level based on the subject matter and context.

Readability formulas, such as the Fry readability formula or the Flesch–Kincaide readability test, can be useful, but, Torchetti cautions, understand their limitations. They each measure only five to ten factors, when readability is based on about a hundred factors. How readability tests can be really useful is as tools to educate clients and to persuade them of what needs to be done to the text to make it clearer.

Faster editing: Using PerfectIt to check consistency and house style—Daniel Heuman (EAC conference 2014)

I’d heard only good things about PerfectIt, the consistency-checking software, but I work on a Mac and didn’t want to run Parallels, so I’ve resisted buying it. Still, I wanted to attend developer Daniel Heuman’s EAC conference talk about the software so that I could learn more about what it can and can’t do.

PerfectIt, by Intelligent Editing, is an add-on to Microsoft Word for PCs, and it runs from the toolbar or ribbon. It’s a consistency checker that alerts you to inconsistencies in your text. These alerts don’t prescribe—it’s quite possible that what PerfectIt flags is all correct. “There are exceptions to every rule,” said Heuman, “so PerfectIt does make you slow down and evaluate each situation.”

PerfectIt will find inconsistencies in:

  • hyphenation. Although right now the software only works for open versus hyphenated compounds, Heuman says that checking for open versus closed versus hyphenated is “on the list” of future improvements.
  • numbers. It will alert you if you’ve deviated from your style and used numerals where you should have spelled out a number, and vice versa. It will not, however, find inconsistencies in the use of a comma or a nonbreaking space in a numeral (e.g., 5,000 versus 5000 versus 5 000).
  • spelling. Not only will it catch “adviser” versus “advisor,” but it will also flag usage inconsistencies, such as “preventive” versus “preventative.” Embarrassing errors that a spell check wouldn’t catch—such as using “pubic” instead of “public” or “mange” instead of “manage”—are also programmed to pop up on a PerfectIt scan.
  • abbreviations. Have you defined an abbreviation? Have you continued to spell it out once it has been defined? PerfectIt will also let you generate a table of abbreviations. (Heuman’s demonstration of this feature prompted a lot of oohs and aahs.) However, the software will not detect inconsistent use of full caps versus small caps.
  • capitalization. PerfectIt will alert you to inconsistencies such as “parliament” versus “Parliament.” It will also check for consistency in header cases—a good reason to use Word’s styles to define your headers.
  • lists. PerfectIt will flag inconsistencies in capitalization and punctuation in lists—but only those styled as lists in Word. It won’t work with manually inserted bullets, for example.

For each potential error that PerfectIt finds, a dialog box pops up that describes the inconsistency; shows you how many cases of each form you have in the document and allows you to choose your preferred form; shows an excerpt of text around each instance of the error, letting you fix each case individually or all of them at once; and states any exceptions to the rule or special considerations in a note box at the bottom.

I asked if PerfectIt could be told to ignore block quotes or text style as quotations. Heuman told me that it will respect the “Do not check spelling and grammar” checkbox, but only after you’ve gone into the advanced settings and told it to, specifically.

PerfectIt will not check grammar, nor will it check references.

One feature that makes the software particularly powerful is the ability to create a style sheet for each client or to import an existing style guide, such as ones from the WHO, UN, EU, or The Economist. PerfectIt can then check your text against the selected style sheet and flag any deviations from it. If you’ve created a style sheet and would like to share it with a client or colleague, it’s easy to export it and send it along.

For those of us who don’t have a PC and aren’t using Parallels, Intelligent Editing does offer an online consistency checker, but it is a “shadow of the full suite.” My fingers are crossed that one day, PerfectIt will be available for Mac users. It does seem to be a powerful time saver, and I imagine that future tweaks to its functionality will only make it better.

Take a walk on the wild side—nonbreaking space edition

Why nonbreaking spaces?

Line breaks like

Mr.
Lee

or

World War
II

hinder readability because readers have to scan to the next line before they receive the information that completes the concept they’re reading about. In these cases, we want to keep the words together, and the best method is to use a nonbreaking space.

I once worked with a company that output its final reports from Word, and whenever something like “$6 million” broke over a line, the in-house staff would use a soft return before the “$6” to push it to the next line. In general, using soft returns is poor practice, because if you delete anything from the line above, you end up with a short line or unsightly gaps (if the text has been fully justified). It’s also poor practice for text that may be repurposed for a reprint or in a different medium: whenever the text reflows, the soft return will yield a shortened line that buggers up the flow of the text.

Instead, a nonbreaking space between “$6” and “million” would tell Word not to break a line at that point. It would keep the entity of “$6 million” together, without disrupting the line length.

You can insert a nonbreaking space in Word by using the shortcut key Option + Space on a Mac or Ctrl + Shift + Space on a PC. The control code for nonbreaking spaces in Word’s Find and Find & Replace functions is ^s.

Isn’t it a proofreader’s job to catch bad breaks?

In a traditional print workflow, the proofreader flags these instances of bad line breaks for the designer. But changing them at the copy-editing stage would head these problems off at the pass and allow the proofreader to focus on other typos and design infelicities that a global search wouldn’t catch. These kinds of global changes are also much easier to do at copy editing—an instance of where a few seconds of effort on the copy editor’s part can save the proofreader a lot of time.

Further, for text destined for a digital format—say a website or an ebook—adding nonbreaking spaces at the copy edit will ensure that the text appears as it should, regardless of reflow.

Wildcard searches for nonbreaking spaces

To save you from having to search each case individually, here are some wildcard searches that can help you do global searches for situations that require a nonbreaking space. This list isn’t exhaustive but should cover the most common cases.

Make sure you have checked off “Use Wildcards” in Word’s Find and Replace dialog box. In some cases, you can safely use the Replace All button; in others, you should go through each occurrence and evaluate it individually.

(Some workflows expect the designer to make these global changes. In InDesign, the codes are different, and I won’t cover them here, but the situations in which you would use the nonbreaking spaces are the same, so you can still use the list below as a reference.)

Dates and times

Times

Depending on style:

Find what Replace with Notes
([0-9]) (<[ap]m>) \1^s\2 Safe to replace all
([0-9]) ([ap].m.) \1^s\2 Safe to replace all

These searches will put a nonbreaking space after a digit and before “am”/“a.m.” and “pm”/“p.m.”

Months

Depending on style:

Find what Replace with Notes
(<[ADFJMNOS][A-z]{2,8}>) ([0-9]) \1^s\2 Evaluate case by case
(<[ADFJMNOS][A-z]{2,8}>.) ([0-9]) \1^s\2 Evaluate case by case

These will put a nonbreaking space both between the month and date and between the month and year (e.g., June 15, 2014 or June 2014).

Transpose the stuff in the parentheses if your style is to state the date before the month (e.g., 25 July).

BC, AD, BCE, etc.

Depending on style:

Find what Replace with Notes
([0-9]) (<[BC]>) \1^s\2 Safe to replace all
([0-9]) (<[AD]>) OR (<[AD]>) ([0-9]) \1^s\2 Safe to replace all
([0-9]) (<BCE>) \1^s\2 Safe to replace all
([0-9]) (<CE>) \1^s\2 Safe to replace all
([0-9]) (<BP>) \1^s\2 Safe to replace all

These searches will put a nonbreaking space between the year and AD/BC; BC/BCE; or BP (before present).

Circa

Depending on style:

Find what Replace with Notes
(<c.>) ([0-9]) \1^s\2 Safe to replace all
(<ca.>) ([0-9]) \1^s\2 Safe to replace all

These searches will put a nonbreaking spaces after “c.” or “ca.” for circa.

Punctuation

If you are using the spaced en dash (rather than a closed em dash), the first space should be nonbreaking. (The pound sign # should be replaced with a tap of the space bar when typing these into the “Find what” box.)

Find what Replace with Notes
#– ^s– Safe to replace all

Same thing if you have spaced ellipses:

Find what Replace with Notes
#… ^s… Safe to replace all

(In French, there’s a nonbreaking space before colons and sometimes exclamation points and semicolons. If the text was created with the French dictionary and autocorrect on, those nonbreaking spaces were probably automatically inserted; otherwise you may have to put them in.)

Names

Initials

If your style has a space between initials, that space should be nonbreaking:

Find what Replace with Notes
([A-Z].) ([A-Z].) \1^s\2 Probably safer to evaluate case by case

(If your style has a space between initials but no periods, then, for the love of all that is merciful, ask whoever decided on this readability-hindering style to change it.)

Honorifics, etc.

Again, replace # with a tap of the space bar in the “Find what” box.

Find what Replace with Notes
<([DM][rs]{1,2}.)# \1^s Safe to replace all

This search puts a nonbreaking space after “Mrs.,” “Ms.,” “Mr.,” and “Dr.”

Find what Replace with Notes
<(St.)#([A-Z]) \1^s\2 Evaluate case by case

This search puts a nonbreaking space after “St.” Although the uppercase letter that follows probably makes it safe to replace all in most situations, evaluating case by case will let you exclude instances where “St.” is used as an abbreviation for something other that “Saint.”

And, once again, replacing # with an actual space in the “Find what” box:

Find what Replace with Notes
#(<Jr>) ^s\1 Safe to replace all

This search puts a nonbreaking space before “Jr.”

Numbers and units

The most common problem is a break between the number and “million”:

Find what Replace with Notes
([0-9]) ([bmqt]?{1,5}llion) \1^s\2 Safe to replace all

This search should replace the space between any digit and “million,” “billion,” “trillion,” “quadrillion,” and “quintillion.”

For cookbooks, these searches will cover most cases where you’d need a nonbreaking space. In all cases you can replace all.

Find what Replace with
([0-9]) (tsp) \1^s\2
([0-9]) (Tbsp) \1^s\2
([0-9]) (cup) \1^s\2
([0-9]) (lb) \1^s\2
([0-9]) (oz) \1^s\2
([0-9]) (mL) \1^s\2
([0-9]) (L) \1^s\2
([0-9]) (hour) \1^s\2
([0-9]) (minute) \1^s\2

If your style calls for a space before °C or °F, do an additional search for

([0-9]) (°[CF]) \1^s\2

In all other contexts, especially scientific ones, there are too many units for me to offer a canned wildcard search that will cover all of them, so just do global searches as you come across them (replace UNIT with your unit name).

Find what Replace with
([0-9]) (UNIT) \1^s\2

For example:

Find what Replace with
([0-9]) (kg) \1^s\2

Miscellaneous

Find what Replace with Notes
(et) (al.) \1^s\2 Safe to replace all

This search keeps et al. together

Find what Replace with Notes
(War) (I{1,2}) \1^s\2 Evaluate case by case

This search will work for both World War I and World War II.

In text that uses binominal nomenclature where the genus is abbreviated (e.g., E. coli), the genus and species should stay together for readability. With your cursor in the “Find what” box, go to the “Format” button at the bottom of the dialog box, select “Font,” then select “Italic.”

Find what Replace with Notes
([A-Z].) ([a-z]) \1^s\2 Evaluate case by case

For text that features math, you’ll want to add nonbreaking spaces before symbols for operations (e.g., +, –, ×, ÷, ±) and possibly also after.

Be on the lookout for these kinds of constructions, where the nonbreaking space should also be used:

  • Section A, Chapter 1, note 5
  • Boeing 747
  • 137 Main Street

Working with designers

Unfortunately, in a Word-to-InDesign workflow, the nonbreaking space (Command + Option + x on a Mac and Ctrl + Alt + x on a PC in InDesign) sometimes doesn’t come through properly. Occasionally it renders as a fixed-width nonbreaking space (which you don’t want, especially for justified texts, because it causes uneven spacing) or as a weird nonsense glyph. Alert the designer that you’ve used a nonbreaking space when you submit your manuscript so that he or she can replace it with a variable-width nonbreaking space if either of those glitches happens.

Text destined for digital

Again, if starting from Word, the nonbreaking space may not come through properly in the conversion process, but they’re important for readability in text that will reflow. The HTML code for nonbreaking spaces is &nbsp;. Talk to whoever is responsible for the conversion to digital to see whether it may be best to search for ^s and replace it with &nbsp; (or whatever the markup system you’re using uses for nonbreaking space) in Word before you submit it for e-production.

Others?

This list is meant to cover common cases only. If there’s an obvious one I’ve missed (or if you notice an error in any of the above), please let me know and I’ll add it.