Posted by: Jack Henry | March 30, 2017

Editor’s Corner: Internet and Email

Were you aware that the 17th edition of the Chicago Manual of Style includes new rules about the words internet and email? Internet now starts with a lowercase letter, and email does not have a hyphen.

Congratulations! You Editor’s Corner subscribers are ahead of the curve and are already following these rules. The Chicago Manual of Style has finally caught up with us!

Here are the standards from the JHA Style Guide for Technical Communication and Training.

Internet

Guideline Example
Do not capitalize internet when it is used as an adjective or as a common noun. Capitalize Internet when it is used as part of a proper noun, but do not capitalize the internet. Correct:

· Sign in to your internet banking account.

· The default internet browser is Internet Explorer®.

· Access the internet to perform research.

Incorrect:

· Sign in to your Internet banking account.

· The default Internet browser is Internet Explorer®.

· Access the Internet to perform research.

Email

Guideline Example
It is not necessary to hyphenate email. Correct: Check your email account regularly.

Jackie Solano | Technical Editor | Symitar®

8985 Balboa Ave. | San Diego, CA 92123 | Ph. 619.542.6711 | Extension: 766711

Symitar Documentation Services

NOTICE: This electronic mail message and any files transmitted with it are intended
exclusively for the individual or entity to which it is addressed. The message,
together with any attachment, may contain confidential and/or privileged information.
Any unauthorized review, use, printing, saving, copying, disclosure or distribution
is strictly prohibited. If you have received this message in error, please
immediately advise the sender by reply email and delete all copies.

Posted by: Jack Henry | March 29, 2017

Editor’s Corner: How to Write About Buttons

A button is a rectangular object that, when clicked, carries out a command. A button may be labeled with text, an icon, or both. Here are some images of buttons:

In general, if a button has a text label, refer to the button only by its label (without the word button). For example, “click OK” or “click Paste.”

If a button has no text label, you can include an image of the icon before the button name, if necessary for clarity (for example, “click Decrease Indent”). Do not include images for buttons with a text label.

Unless you are writing for novice computer users, it is not necessary to include images for commonly used buttons like Save or Close, even though they do not have text labels.

In fact, when writing for intermediate users, you might not need to mention these buttons at all. Most readers can understand instructions like, “Save the document to your desktop” or, “Close the Options dialog box” without further explanation.

Ben Ritter | Technical Editor | Symitar®
8985 Balboa Avenue | San Diego, CA 92123
619-682-3391 | or ext. 763391 | www.Symitar.com

Symitar Documentation Services

NOTICE: This electronic mail message and any files transmitted with it are intended
exclusively for the individual or entity to which it is addressed. The message,
together with any attachment, may contain confidential and/or privileged information.
Any unauthorized review, use, printing, saving, copying, disclosure or distribution
is strictly prohibited. If you have received this message in error, please
immediately advise the sender by reply email and delete all copies.

Posted by: Jack Henry | March 28, 2017

Editor’s Corner: Spelling

Good morning, folks! My dear, dachshund-loving friend Ron left the following article on my desk. I couldn’t resist sharing it with you, because it’s written by Richard Lederer, our local verbivore, and it’s about spelling and banks. It has something for everyone here at JHA! I’ve cut a few things out, but if you’d like to read it in its entirety, you can see it here.

This Thursday, the Union-Tribune will hold its annual countywide spelling bee. On the model of the collectively busy bee, we call these events spelling bees. In 19th-century America a bee indicated a community effort in which neighbors pitched in, often to help out a family. Examples include chopping bee, husking bee, logging bee, quilting bee, house- or barn-raising bee, sewing bee, spinning bee and, ultimately, spelling bee.

A man, wanting to rob a downtown Corpus Christi Bank of America, walked into the branch and wrote, “This iz a stikkup. Put all your muny in this bag.” While standing in line, waiting to give his note to the teller, he began to worry that someone had seen him write the note and might call the police before he could reach the teller window. So he left Bank of America and crossed the street to Wells Fargo.

After waiting a few minutes in line, he handed his note to the Wells Fargo teller. She read it and surmised from his spelling errors that he was not the sharpest knife in the drawer. She told the would-be robber that she could not accept his stick-up note because it was written on a Bank of America deposit slip and that he would either have to fill out a Wells Fargo deposit slip or go back to the Bank of America.

Looking somewhat defeated, the man said, “Okay,” left the bank and headed back across the street. The Wells Fargo teller then called the police, who arrested the man a few minutes later as he was waiting in line back at the Bank of America.

Another bank robber in Bumpis, Tennessee, handed a teller the following note: “This is a rubbery. I have an oozy traned on your but. Dump the munny in a sack, this one. No die pakkets or other triks or I will tare you a new naval. No kwarters with red stuff on them, too.” The teller started laughing, and the man fled the bank in embarrassment and with no booty.

In both instances, we note the relationship between bad spelling and incompetent commission of a felony. Educationist Dr. Creon V. B. Smyk says such notes are, lamentably, the rule. “Right across the board, we see poor pre-writing skills, problems with omissions, tense, agreement, spelling and clarity,” he laments.

Here’s more evidence that a spell of bad English has afflicted our great nation:

· If a tree falls in the dessert, does it make a sound?

· In Pittsburgh they manufacture iron and steal.

· East Texas Cable Company: Please bare with us while we are working to improve service.

· On Thanksgiving morning we could smell the foul cooking.

· Vestal virgins were pure and chased.

· Marital Arts Studio

· You are invited to Sally Curtis’s retirement party. No gifts, just the honor of your presents.

Jack and Schnitzel help Ron collect newspaper articles and badgers to share with all of us!

Kara Church

Technical Editor, Advisory

Symitar Documentation Services

Posted by: Jack Henry | March 27, 2017

Editor’s Corner: Semicolon Revisited

Greetings! While on vacation recently, believe it or not, I had a lively conversation with my cousin and his girlfriend about semicolons. Stop laughing.

Anyway, the conversation reminded me that it’s been a while since we discussed this misunderstood yet lovely piece of punctuation.

While we don’t use semicolons often in technical writing, we do use them sometimes, so it’s good to know the rules. Here are the three simple rules you need to know:

Rule 1 (This is the main rule, so pay attention!): A semicolon combines two main clauses (also known as independent clauses or complete sentences). We use a semicolon (rather than a period) to show that there is a close relationship between two sentences.

For this rule, it might help to think of a semicolon as a weak period—but don’t capitalize the second clause.

Example: The mail carrier drove right past my mailbox today; he must still be angry about the Rover incident.

Important: Do not use semicolons with conjunctions (and, but, or, nor, for, so, and yet).

Incorrect example: The mail carrier drove right past my mailbox today; so he must still be angry about the Rover incident.

Rule 2: Use a semicolon between main clauses joined by however, for example, etc.

Example: The mail carrier drove right past my mailbox today; however, he waved as he passed, so I think he’ll be back someday.

Rule 3: Use a semicolon between a series of items that contain commas. For this rule, it might help to think of a semicolon as a super comma.

Example: The mail carrier delivers mail to San Diego, CA; Poway, CA; and Escondido, CA.

Rover Burcher

(Rover wants you to know that the supposed incident with the mail carrier is merely a figment of my imagination.)

Donna Bradley Burcher | Senior Technical Editor | Symitar®

8985 Balboa Ave. | San Diego, CA 92123 | Ph. 619.278.0432 | Ext: 765432

Posted by: Jack Henry | March 24, 2017

Editor’s Corner: Rank

Dear Editrix,

I was just wondering if there was a relationship between rank (as in rank and file) and rank (as in a nasty smell)?

Sniffer in San Diego

Dear Sniffer,

It sounds like you might’ve had a rough night with a smelly soldier! I hope that is not the case and this is just your inventive curiosity.

I checked out both Meriam-Webster and my favorite Online Etymology Dictionary for different definitions of rank. Neither of them defined rank as a stinky smell, though the latter of the two came pretty darn close. I know a visit to the Paris sewers brought the word rank to my lips!

Here are the different items I found:

rank (noun)

early 14c., "row, line series;" c. 1400, a row of an army, from Old French renc, ranc "row, line" (Modern French rang), from Frankish *hring or some other Germanic source (compare Old High German hring "circle, ring"), from Proto-Germanic *hringaz "circle, ring, something curved" (see ring (n.1)).

Meaning "a social division, class of persons" is from early 15c. Meaning "high station in society" is from early 15c. Meaning "a relative position" is from c. 1600.

rank (adjective)

Old English ranc "proud, overbearing, showy," from Proto-Germanic *rankaz (source also of Danish rank "right, upright," German rank "slender," Old Norse rakkr "straight, erect"), perhaps from PIE *reg- "to stretch, straighten" (see right (adj.)). In reference to plant growth, "vigorous, luxuriant, abundant, copious" it is recorded from c. 1300.

Sense evolved in Middle English to "large and coarse" (c. 1300), then, via notion of "excessive and unpleasant," to "corrupt, loathsome, foul" (mid-14c.), perhaps from influence of Middle French rance "rancid." In 17c. also "lewd, lustful."

Much used 16c. as a pejorative intensive (as in rank folly). This is possibly the source of the verb meaning "to reveal another’s guilt" (1929, underworld slang), and that of "to harass, abuse," 1934, African-American vernacular, though this also may be from the role of the activity in establishing social hierarchy (from rank (n.)).

rank (verb)

1570s, "arrange in lines;" 1590s, "put in order, classify; assign a rank to," from rank (n.). Related: Ranked; ranking.

Kara Church

Technical Editor, Advisory

619-542-6773 | Ext: 766773

Symitar Documentation Services

NOTICE: This electronic mail message and any files transmitted with it are intended
exclusively for the individual or entity to which it is addressed. The message,
together with any attachment, may contain confidential and/or privileged information.
Any unauthorized review, use, printing, saving, copying, disclosure or distribution
is strictly prohibited. If you have received this message in error, please
immediately advise the sender by reply email and delete all copies.

Posted by: Jack Henry | March 23, 2017

Editor’s Corner: How to Describe Keys, Part 4

Function Keys

The function keys are labeled F1 through F12. Describe these keys with an uppercase letter F and a number, with no space in between (for example, “Press F1”). You may say the and key on first mention if it helps with clarity (for example, “Press the F1 key”).

Arrow Keys

The arrow keys move the cursor. Collectively, they are called “the arrow keys” (lowercase), but individually, they are called the Left Arrow key, the Right Arrow key, the Up Arrow key, and the Down Arrow key.

When referring to the arrow keys, always say the and key (for example, “Press the Right Arrow key”), unless you are referring to them in combination with another key (for example, “Press Shift+Right Arrow”).

Command Key and Windows Logo Key

The ⌘ Command key appears only on Apple® keyboards. It works similarly to the Ctrl key on a Windows® keyboard. You don’t need to say the and key, but you should use an image of the key whenever possible (for example, “Press ⌘ Command+C”).

The Windows logo key appears only on Windows keyboards. It opens the Start menu and is used in various keyboard shortcuts (for example, press Windows logo key+L to lock your desktop). When referring to the Windows logo key, Windows is capitalized, but logo and key are not.

…and the Rest

There are 15 other keys we have not discussed, but they follow the same general rules that apply to modifier keys. Capitalize the first letter of each word, and abbreviate as shown:

· Backspace

· Caps Lock

· Delete

· End

· Enter

· Esc

· Home

· Insert

· Num Lock

· Page Down

· Page Up

· Pause (or Break)

· Print Screen

· Scroll Lock

· the Tab key

Tip: To avoid confusion with tabs on a ribbon, on a webpage, or in a dialog box, always say “the Tab key,” except when you are referring to the Tab key in combination with another key (for example, “Press Alt+Tab”).

Ben Ritter | Technical Editor | Symitar®
8985 Balboa Avenue | San Diego, CA 92123
619-682-3391 | or ext. 763391 | www.Symitar.com

Symitar Documentation Services

NOTICE: This electronic mail message and any files transmitted with it are intended
exclusively for the individual or entity to which it is addressed. The message,
together with any attachment, may contain confidential and/or privileged information.
Any unauthorized review, use, printing, saving, copying, disclosure or distribution
is strictly prohibited. If you have received this message in error, please
immediately advise the sender by reply email and delete all copies.

Posted by: Jack Henry | March 22, 2017

Editor’s Corner: Anyway versus Any Way

Some of you have asked me to explain when to use anyway, any way, and anyways. Let’s stop right there. Anyways is very informal, and in our work we shouldn’t be using it. Put it back in the sack with anywho, and save it for those times when you’re kickin’ it on the porch drinking beer in the sunshine.

Now, for the more traditional and professional anyway.

Anyway is an adverb that means nonetheless, regardless, or in any case.

For example:

· The doctor told me not to eat dried mango with chili powder, but I bought some and ate it anyway.

· Janie heard that it was icy cold in Siberia, but she’s going on vacation there, anyway.

Anyway can also be used when a story has been interrupted, and speaker is ready to continue.

· Anyway, as I was saying earlier, Bob got pec implants and now he looks like Superman.

Any way is two separate words that mean “by any means” or “in any manner.”

· The barkers will get kids to spend their money on carnival games any way they can.

· The barkers will get kids to spend their money on carnival games in any manner they can.

· The barkers will get kids to spend their money on carnival games by any means they can.

Hint: If you can read the sentence and replace the words with “the way,” then you want two separate words: any way. If it doesn’t make sense, you want anyway.

La Sirena coaxes the young sailors any way she can. (GOOD)

La Sirena coaxes the young sailors the way she can. (ACCEPTABLE)

Michelangelo wanted to be a bookkeeper, but his mother sent him to art school, anyway. (GOOD)

Michelangelo wanted to be a bookkeeper, but his mother sent him to art school, the way. (NONSENSICAL)

Kara Church

Technical Editor, Advisory

Symitar Documentation Services

Posted by: Jack Henry | March 21, 2017

Editor’s Corner: Oxford Comma Legal Drama

Hello, fair Editor’s Cornerians! Several of you have asked about the Oxford (or serial) comma and why we use it. In case you aren’t sure of what I’m talking about, it is the comma in a list that comes right before the conjunction.

For example:

· “He’s expecting his friends, Tyne Daly, and his mom at dinner.”

That seems clear: his mom, Tyne Daly, and his other friends are coming to dinner. Without that comma before the and, I (and many others) argue that the reader might be confused.

· “He’s expecting his friends, Tyne Daly and his mom at dinner.”

In this case, are we talking about several people? Or are Tyne Daly and his mom his only friends coming to dinner?

Here is a legal case, that several of you have sent my way, which shows us why the Oxford comma is a good thing.

From the ABA Journal:

Oxford comma issue benefits drivers in overtime case

Ambiguity caused by lack of a comma in a law on overtime pay has benefited Maine dairy delivery drivers.

The Boston-based 1st U.S. Circuit Court of Appeals pointed out the issue in the first sentence of its March 13 decision (PDF). “For want of a comma, we have this case,” the court said in an opinion by Judge David Barron. The Daily Labor Report, Quartz and FindLaw have stories.

Because the statute was ambiguous, it should be interpreted in favor of the dairy workers who distribute milk but do not pack it, the appeals court found.

The court was asked to interpret a Maine law that requires overtime pay, except for some activities that involve foods, including “packing for shipment or distribution” of the foods. The court was asked to decide whether “packing for shipment or distribution” referred to one activity that involves packing or two separate activities—one that involves packing and the other that involves distribution. If distribution were a separate activity, the workers couldn’t collect overtime.

The statute provided that workers were not entitled to overtime if their jobs involved “the canning, processing, preserving, freezing, drying, marketing, storing, packing for shipment or distribution of: (1) agricultural produce; (2) meat and fish products; and (3) perishable foods.”

Because there was no comma after “packing for shipment,” the drivers argued, “distribution” was not a separate activity. They also provided another grammatical argument: The first items in the list—canning, processing and the like—were gerunds, while the words “shipment” and “distribution” were not. That showed that “distribution,” like the word “shipping,” was an object of the preposition “for”—and was not a separate activity that barred them from collecting overtime.

The drivers’ employer had pointed to a lack of a conjunction before “packing.” The drivers responded with a citation to a book by the late Justice Antonin Scalia and Bryan Garner that says statutory drafters sometimes omit conjunctions in a list in a technique called “asyndeton.”

The appeals court noted the conflicting arguments and sided with the drivers, citing the protective purpose of the overtime law. According to Quartz, “the profoundly nerdy ruling is … a win for anyone who dogmatically defends the serial comma,” which also is known as the Oxford comma.

Kara Church

Technical Editor, Advisory

619-542-6773 | Ext: 766773

Symitar Documentation Services

NOTICE: This electronic mail message and any files transmitted with it are intended
exclusively for the individual or entity to which it is addressed. The message,
together with any attachment, may contain confidential and/or privileged information.
Any unauthorized review, use, printing, saving, copying, disclosure or distribution
is strictly prohibited. If you have received this message in error, please
immediately advise the sender by reply email and delete all copies.

Posted by: Jack Henry | March 20, 2017

Editor’s Corner: Funny Old-fashioned Insults

What better way to start a Monday than with a list of old-fashioned insults? First, a (probably unnecessary) caveat: these words are meant to give you a chuckle not to provide ammunition you can use against your coworkers, friends, family, or even enemies. If you feel the urge to blast one out, remember our JHA motto: Do the right thing.

I got this list from a Dictionary.com slideshow, but they made it clear that you won’t find these words defined in their dictionary because the words are obsolete.

Compared to the invectives we hear today, these words sound like insults a Brownie troop would fling—but they were once considered offensive. I love the whimsical imagery they provide.

· Bedswerver: Shakespeare coined this word to describe an adulterer.

· Fopdoodle: Someone of little significance.

· Gnashnab: An 18th century northern English word, meaning someone who complains all the time.

· Gobermouch: An old Irish term for someone who likes to meddle in other people’s business.

· Klazomaniac: A person WHO CAN ONLY SPEAK BY SHOUTING.

· Scobblelotcher: Someone who avoids hard work like it’s his or her job.

· Snoutband: Someone who always interrupts a conversation to correct or contradict.

· Stampcrab: Someone who’s heavy of foot.

· Whiffle-Whaffle: Someone who wastes a lot of time.

· Zooterkins: Not really an insult, this is something you yell after someone has insulted you.

· Zounderkite: A Victorian word meaning idiot.

Have a fun day.

Donna Bradley Burcher | Senior Technical Editor | Symitar®

8985 Balboa Ave. | San Diego, CA 92123 | Ph. 619.278.0432 | Extension: 765432

Symitar Technical Publications Writing and Editing Requests

NOTICE: This electronic mail message and any files transmitted with it are intended
exclusively for the individual or entity to which it is addressed. The message,
together with any attachment, may contain confidential and/or privileged information.
Any unauthorized review, use, printing, saving, copying, disclosure or distribution
is strictly prohibited. If you have received this message in error, please
immediately advise the sender by reply email and delete all copies.

Posted by: Jack Henry | March 17, 2017

Editor’s Corner: Fetching

One of the lovely women I work with was called fetching the other day, and she remarked how her first thought was that of a dog chasing a ball rather than of looking nice. From there, she wondered about how fetching became a compliment. Today, let’s look at a few words that are complimentary but not standard everyday fare.

· alluring (adj)

"appealing to desires," 1570s, present participle adjective from allure (v.).

· becoming (adj)

"looking well," 1560s, from earlier sense of "fitting" (early 13c.), from present participle of become. Related: Becomingly; becomingness.

· comely (adj)

"beautiful, handsome," c. 1400, probably from Old English cymlic "lovely, splendid, finely made," from cyme "exquisite, glorious, delicate," from West Germanic *kumi- "delicate, feeble" (source also of Old High German chumo "with difficulty," chumig "weak, delicate;" German kaum "hardly, scarcely"). Or. perhaps the modern word is from Middle English bicumelic (c. 1200) "suitable, exquisite," literally "becomely" (compare becoming).

· dapper (adj)

mid-15c., "elegant," from Middle Dutch or Middle Low German dapper "bold, strong, sturdy," later "quick, nimble," from Proto-Germanic *dapraz, perhaps with ironical shift of meaning (source also of Old High German tapfar "heavy," German tapfer "brave"), from PIE root *dheb- "dense, firm, compressed."

· fetching (adj)

1580s, "crafty, scheming," present participle adjective from fetch (v.), in one of its extended senses, here "bring or draw into a desired relation or condition." The sense of "alluring, fascinating" is by 1880, from the verb in the sense "allure, attract, fascinate" (c. 1600). Related: Fetchingly.

For some other related words, you can read more at the Online Etymology Dictionary. I must warn you, a few of the terms aren’t so complimentary!

Kara Church

Technical Editor, Advisory

619-542-6773 | Ext: 766773

Symitar Documentation Services

NOTICE: This electronic mail message and any files transmitted with it are intended
exclusively for the individual or entity to which it is addressed. The message,
together with any attachment, may contain confidential and/or privileged information.
Any unauthorized review, use, printing, saving, copying, disclosure or distribution
is strictly prohibited. If you have received this message in error, please
immediately advise the sender by reply email and delete all copies.

« Newer Posts - Older Posts »

Categories