An American Editor

May 8, 2017

The Business of Editing: The AAE Copyediting Roadmap XII

In the previous 11 essays in The Business of Editing: The AAE Copyediting Roadmap series, I discussed how I approach a manuscript for editing. If you have read the series, you will have noted the common denominator of the macros I use in my approach to editing: they increase efficiency and accuracy, and thus increase my profitability, which is the subject of this final essay in the series.

We live and work in an increasingly competitive editorial world. Editors who began their careers in one specialty are expanding into other fields. Nonfiction editors are willing to take on fiction and vice versa. There are multiple reasons for that expansion, not least of which is that there are more people calling themselves editors and who are willing to work for a low price. The problem experienced professional editors face is that clients become used to paying a low rate for editorial work and expect all editors, regardless of expertise or experience, to work for that same low rate that unprofessional, inexperienced editors are willing to work.

Some editors are in a position to turn away work that is priced lower than they want to accept, but most editors are not. Faced with work that pays less than desired, editors need to figure out how to edit more quickly — that is, to be more efficient, more accurate, and more profitable. There are only so many options available. There are, for example, limits to the amount of time that can be spent editing each day without sacrificing accuracy. Besides, increasing the number of hours we work each day or the number of days we work in a week does not increase efficiency, accuracy, or profitability — it simply means that more work gets done because more time is devoted to working. What we really want is to get more work done in less work time.

Macros like those in EditTools do enhance efficiency, accuracy, and profitability because they make repeating tasks that take time to perform and accomplish the task in less time and with greater accuracy. If the editor charges by the project or the page, that saved time and greater accuracy leads to increased profitability.

Editors evaluate editorial aids by a variety of standards but the one “failing” that many editors have in their evaluation process is that they refuse to buy an aid that has many tools only one of which the editor thinks she will use. Consider, for example, Jack Lyon’s Editor’s Toolkit Plus 2014. This collection of macros includes macros that many editors do not use, such as QuarkConverter. I have had editors tell me that they haven’t bought Toolkit Plus because there are so many macros in the collection for which they have no need. When asked whether there are macros included that they think they would use regularly, most editors say yes and point especially to FileCleaner. Yet these same editors do not consider regular use of FileCleaner as sufficient to justify buying Toolkit Plus. (For what it’s worth, my favorite macros in the Toolkit Plus collection are ListFixer and NoteStripper; I almost never use any of the other macros, but I use these two frequently.)

To me, this is faulty thinking: If I think I would use FileCleaner regularly, and if using it would make me more efficient, accurate, and profitable, then I need to buy and use Toolkit Plus. It doesn’t matter how many of the included macros I will never use; all that matters is that there is one macro I will use repeatedly and that that macro will increase my efficiency, accuracy, and profitability.

The key for successful editing in a competitive climate is that editors take steps to be more profitable. In making a buying decision regarding a collection of macros, there are two items to consider: (1) that at least one macro in the collection has “super” value for the editor because it solves a specific problem that would require a lot of time and effort to resolve without the macro, and (2) that the editor can expect to face this type of problem more than once in the editor’s career. For example, for me, ListFixer and NoteStripper are invaluable; I cannot imagine not having these two macros available. I often get manuscripts in which the author has used Word’s autonumbering for a list. When I move the manuscript into the client’s template, the numbering often disappears, which means I now need to compare the original manuscript to the templated version to see what paragraphs should be numbered. That takes time. If I use ListFixer, I can convert the autonumbered lists to fixed-number lists in seconds. The cost of Toolkit Plus is quickly recovered and I have a tool that increases efficiency, accuracy, and profitability — even if I never use any other macro in Toolkit Plus.

The same kind of reasoning applies to EditTools. Although I use most of the macros in EditTools regularly, the most valuable macros in the EditTools collection for my editing are these: Toggle (see The Business of Editing: The AAE Copyediting Roadmap VIII), the complementary pair Insert Query (see The Business of Editing: The AAE Copyediting Roadmap X) and Comment Editor (see The Business of Editing: The AAE Copyediting Roadmap XI and The Business of Editing: Managing Comments with Comment Editor), and Enhanced Search, Count, and Replace (see The Business of Editing: The AAE Copyediting Roadmap IX). These four macros address the core of editing and each is designed to increase efficiency, accuracy, and profitability. Having spoken with other EditTools users, I know that other editors find other macros in the collection to be more valuable in their practice.

The point is that in today’s competitive editorial world, every second counts and editors need to figure out what repetitive tasks they perform while editing that can be made more efficient, accurate, and profitable by using a tool that is available in the marketplace. As I have noted in other essays, editors need to reuse the wheel, not reinvent it each time they face a problem.

With globalization and increased competition, editors need to do what is necessary to increase efficiency, accuracy, and profitability. Editors need to overcome the reluctance to invest in a macro collection that can make their editing more profitable because the collection only has one tool the editors think can help them. As several editors have expressed to me, they bought a collection of macros for a specific macro but once they started experimenting with the macros in the collection, they discovered additional macros that helped increase their efficiency, accuracy, and profitability.

Richard Adin, An American Editor

(Disclosures: (1) I am the creator of EditTools and have a financial interest in wordsnSync’s EditTools. (2) I have no connection with and no financial interest in The Editorium’s Editor’s Toolkit Plus 2014 except as a purchaser and user of the product.)

May 1, 2017

The Business of Editing: The AAE Copyediting Roadmap XI

In The Business of Editing: The AAE Copyediting Roadmap X, I discussed how I use Insert Query to insert a query or comment into the manuscript. Sometimes an inserted query needs to be modified or deleted or just reviewed. With Microsoft’s system, you need to find that inserted comment and go to it. Most of the time I do not want to leave my current editing location, but Microsoft doesn’t let me stay. Consequently, I use EditTools’ Comment Editor to deal with already-inserted comments.

Comment Editor, shown below (you can make an image in this essay larger by clicking on the image), lets me either move to the comment and then return to where I was in the manuscript (#1 and #2 in image; if I check the boxes in #1, I will automatically be taken to and returned from a selected comment every time I select one, whereas #2 lets me make the leap only when I click the buttons; I prefer to use method #2) or deal with the comment without moving from my current location. In addition, it gives me the ability to find the comment I want to modify (or delete) without having to go through each comment (#3). This is particularly useful in a chapter with a lot of comments (in the example shown in the image, the chapter has 54 comments).

The Comment Editor dialog

Comment Editor shows all of the comments I have inserted in the manuscript using either Insert Query, which was discussed in The Business of Editing: The AAE Copyediting Roadmap X, or Microsoft’s method. In other words, Comment Editor does not require using Insert Query. Comment Editor also displays comments that were inserted by either the authors or other editors before I was given the manuscript. It is not necessary for a comment to be inserted using Insert Query for it to appear in Comment Editor; it just has to be a properly inserted comment.

Comment Editor lets me use the scrollbar (#4 in image below) to scroll through the comments until I find the one I want. When I find the comment I want to review, edit, or delete, I select it (#5). The complete text of a selected comment appears in the text box (#6).

Selecting a query for editing

With the selected comment text in the text box, I can edit the comment, as shown here:

Editing the selected query

The highlighted text in the above image identifies the change I made. (The highlighting is just to show the modification I made; you cannot highlight the comment text. Although Comment Editor makes editing of comments easier, it is still limited by what actions Microsoft will allow.) Clicking Update (#7) modifies the comment in the document. If I want to delete the comment, I click Delete (#8). I generally do not keep Comment Editor open as I work as I do not often have to edit or delete a comment. But when I do keep it open, I click the Refresh button (#9 in the above image) to refresh the list of comments displayed (#10). Refreshing will show the comments that remain in the manuscript and their renumbering. In other words, had I deleted rather than modified the selected comment, then the comment immediately following it would have become FES25. Refreshing would show that change without requiring closing and reopening Comment Editor.

Microsoft imposes limits on the length (i.e., number of characters including spaces) a comment can be (#11 in the above image). I admit that it is rare that I would write a comment that comes close to that limit, but there have been a couple of times in my editing career when I have come close to that limit. Sometimes a lengthy explanation is needed. Remember that we are talking about characters with spaces, not words. To give you an idea of the difference, the preceding paragraph (“The highlighted text…and reopening Comment Editor.”) is 160 words but 943 characters. The maximum size a comment can be is 2000 characters; Comment Editor keeps me posted on the length of a comment (#11).

A good example of the utility of Comment Editor is shown in the next image. While editing the chapter from which these examples are drawn, I came across the initialism ITP, which can substitute for several diseases. Based on context, I replaced ITP with immune thrombocytopenia (ITP); however, the author could have meant idiopathic thrombocytopenic purpura. Consequently, I inserted the comment shown.

An example

Note that it is the third comment in the chapter. Suppose the author defined ITP much later in the chapter as idiopathic thrombocytopenic purpura. That means I erred in my expansion of ITP earlier. Of course, there are several ways to locate the earlier expansion of ITP, including using Bookmarks (see The Business of Editing: The AAE Copyediting Roadmap IV for how bookmarks can be used), but what I really need to know is whether I misdefined ITP and did I query it. I can check Comment Editor and when I find comment numbered FES3, I can move to it, correct the expansion, run the Enhanced Search, Count, and Replace macro (see The Business of Editing: The AAE Copyediting Roadmap IX for a discussion of this macro), return to where I was in the manuscript when I discovered the error, and either delete or modify the comment.

Although not necessary, I view Insert Query and Comment Editor as complementary — a united pair of macros; that is, I insert all comments using Insert Query and I edit all comments using Comment Editor. Comment Editor is an easy way to navigate and modify comments. Combined with Insert Query, it minimizes the amount of time needed to locate and deal with comments. The quicker and more efficiently I can deal with comments, the more profit I make.

Do you have a more efficient method for editing comments and queries?

Richard Adin, An American Editor

April 24, 2017

The Business of Editing: The AAE Copyediting Roadmap X

In The Business of Editing: The AAE Copyediting Roadmap IX, I discussed the Enhanced Search, Count, and Replace (SCR) macro and how I use it while editing manuscript. This essay deals with inserting queries/comments into the manuscript during editing.

When I first began freelancing, a client (an in-house production editor) told me that as important as good editing skills are, even more important is how authors are queried. The reason, the editor said, is that when I speak to the author, I am speaking on behalf of the client. Of course, that got me thinking about comments and led me to the realization that comments are not only important as alerts to clients and authors about potential problems, but as a marketing tool for me. I wish I could say that I never let frustration with a manuscript or a client appear in comments I have inserted, but I can say that when the frustration appeared, I had made a conscious decision to let it appear.

Querying the author or the in-house editor or the compositor is usually done in one of two ways: (a) inserting the comment inline in the text or (b) inserting the comment as balloon text such as is done using Word’s Comment feature. Because time is money in my editorial business, I rely on EditTools’ Insert Query and Comment Editor macros to insert queries. (For this essay, “queries” and “comments” are used interchangeably and the one includes the other. The oft-stated distinction between the two terms is that a query asks a question whereas a comment makes a statement [e.g., “AQ: Is it OK/correct that I changed 1 to 2 to conform with the previous quantity?” is a query, whereas “Ed/COMP: This needs to be set in sans serif.” is a comment].) Insert Query lets you choose between inserting the comment as a Word comment (balloon text) or inline, as shown here (you can make an image in this essay larger by clicking on the image):

Choose method for inserting a query

I have repeatedly said that time is money when editing. My goal is to minimize the time I need to spend doing “routine” tasks and maximize the time I have available for actual editing. Prior to Insert Query, I had to keyboard every query, even if it was the same query, perhaps with some modification, as inserted a dozen times before in the manuscript. Keyboarding slowed me down considerably. Although I have become a fairly decent typist over the years, I still am neither a fast typist nor one with 100% accuracy. So, keyboarding a query longer than a few words took (takes) time — time for the original keyboarding and time to review that keyboarding and time to correct the errors in my keyboarding.

Using keyboard shortcuts sped up the process but was limited for many reasons. After a while it became difficult to remember all of my keyboard shortcuts — I had them for everything, not just for queries — and there was a limit to how many quickly accessible keyboard shortcuts I could create. I eventually kept a list of my keyboard shortcuts, but that wasn’t a panacea because as the list grew, I had to take the time to look up the shortcut. Also complicating the situation was when I needed to modify a query: the original query was written for Jones on Capitalistic Medicine and now needs to be modified for Smith on Mercy Medicine. These and other limitations and problems led to the Insert Query macro.

As the image below shows, using Insert Query I am able to store a large number of “standard” queries (#A in image; the count shows the number of saved queries for the Reference Queries tab [#1] only) and access them as I need them. To make it easier and quicker to access a query, I separate the queries into categories (#2) that I create. After selecting the category, I select the query (#3) I want to insert. The selected query appears in the “insert” windows (#4), where I can modify the query if necessary. In this example, there are three underscores that need to be replaced with the relevant information. It is in this field (#4) that I make the change, after which I click Insert to have the query inserted in the text as a balloon comment.

Selecting, modifying, & inserting a query

One of the tabs is a project-specific tab (#5 in the image below; all of the tabs work the same, so you can not only rename any of the tabs, but you can have multiple project-specific tabs). As is shown at #B, this tab has 104 available project-specific queries from which I can choose. What I do is copy a query that I need for a project from one of the other tabs and add it (clicking Add to add it to the dataset rather than Insert to add it to the document) to the project-specific dataset. When I am done with a project, I copy those queries that I specially created for the project and that did not come from another tab that I think will be usable for other projects to one of the other tabs.

Project-specific queries

Take a look at the query shown in the above image (#6). How many times would you like to type it? Once was enough for me. Yet look at the query. The query packs a lot of information and shows that I did my job. It tells both the client and the author that I am competent and knowledgeable. Most importantly, as several clients have commented on seeing this and similar queries, it tells the author that the client has selected a professional editor and that the client cares about the author’s book; it gives the author confidence in the quality of the editing and competency of the editor; and it confirms to the client that a wise choice was made when I was selected to edit the book. In other words, it acts as a marketing tool.

It is easy to “perfect” a query when you only have to think of it once and only have to keyboard it once. In addition, it is easy, with a tool like Insert Query, to maintain a library of queries. Because I can create as many categories as I want (#7), I can organize the queries into logical groups that make finding the right query quick.

I use Insert Query to insert every comment that gets inserted in a manuscript. Even if I do not have the exact query I want in a dataset, I have found that using Insert Query to modify an existing comment or to create a new comment works best for me. Using Insert Query gives me the opportunity to add the revised or new query to my dataset without having to enter it twice.

Remember that the idea is to create the wheel once and reuse it, not recreate it each time. Comments can be time-consuming. Insert Query saves me time, thus making me more profitable; even a savings of just a few seconds per query can add up over time to a significant increase in profit. Additionally, Insert Query reduces the number of embarrassing typing mistakes that are made, thereby making me look more professional.

Sometimes a comment needs to be modified, deleted, or reviewed. The Business of Editing: The AAE Copyediting Roadmap XI discusses how I use Comment Editor when I need to access an already inserted comment.

Richard Adin, An American Editor

April 17, 2017

The Business of Editing: The AAE Copyediting Roadmap IX

In The Business of Editing: The AAE Copyediting Roadmap VIII, I began discussing the macros I use during editing. My discussion continues with the Enhanced Search, Count, and Replace (SCR) macro.

I use SCR frequently during editing. The macro searches the text looking for a selected word or phrase (in the example shown below, “Ebola virus disease (EVD)”) and tells me how many times it appears in the text and in what form. The first step is to select the word or phrase to be checked, as shown here (you can make this image, as well as other images in this essay, larger by clicking on the image):

Selecting the search term or phrase

Once I have selected the search term, I run SCR. The macro automatically will “create” search variations (see image below). I can choose to let the macro search for all (leave all of the “Include” checkboxes checked) or some (uncheck those I don’t want included in the search) of those variations and by clicking the “Add terms” button, I can add variations I want included in the search (e.g., I could add “eVD” or “ebola Virus disease”). Usually I just leave all of the items checked and do not add additional terms; occasionally I make additions and changes.

SCR’s options dialog

Tip: Be sure to check what the macro is going to search for and think about it. Macros are dumb and do exactly as instructed. Consequently, if your search phrase is “T-helper (Th)” the macro will find every word that begins “Th” or “th” or “TH”. The search has the same limitations as the standard Word search. Sometimes there is no avoiding getting a return with excess information, but other times a tweak in the search term (e.g., unchecking “Th” and adding “Th-1” and “Th1”) can accomplish what you want.

Clicking OK starts the the text search. SCR searches from the point of the selected text to the end-of-text bookmark (the remhigh or refs bookmark); the search begins with the first alphanumeric character following the selected term or phrase. In my work, I do not want it to search references, tables, or figure legends; I just want the main text searched. The search is quick, and produces a report similar to that shown here:

Search results

In this sample search, two instances of “EVD” and no instances of “Ebola virus disease” were found. Because this client has a general rule (I write “general” because there are times when the rule is not applied) that an acronym/initialism has to appear more than three times in the chapter (if it does not, then instances of the acronym/initialism have to be spelled out; if it does, then subsequent instances of the spelled out version need to be converted to the acronym/initialism), I know to convert “EVD” to “Ebola virus disease” in this chapter. I do so by entering the text in the replace field as shown here:

Replacing text

Clicking OK will cause the macro to replace those instances of “EVD” with “Ebola virus disease” as shown below. Note in the image that the change is automatically made with tracking on.

Replacing the text with tracking on

I repeat the procedure in the next images to show what happens when there are more than a few options found. In this next example, the chosen phrase is “World Health Organization (WHO)”:

Selecting the search term

The SCR macro automatically looks for the variations shown here:

SCR automatically searches for these variations

and returns the report shown here:

The search results

There are 75 instances of WHO (#1 in above image) and two instances of World Health Organization (#2) in the chapter. Applying the client’s rule, the 75 instances of WHO need to be highlighted (#3) and the two instances of World Health Organization need to be changed to WHO (#4).

Tip: The count that is returned by the SCR macro does not include the original selected text. In this example, the selection was “World Health Organization (WHO)” (see earlier image), so that instance was not included. What that means is that the true count is 76 instances of “WHO” and three instances of “World Health Organization” appear in the text. Had I selected only “World Health Organization” as the search text, “WHO” would not have been counted unless I manually added it as an additional search term, meaning that the search result would have been three instances of “World Health Organization”.

When searching, the macro (most of the time, but not always) ignores parentheses and square brackets. To make it easier to add additional variations or to enter replacement text, when I select the text to be searched for, I also copy it to the clipboard. That way I can paste the phrase into the appropriate blank field rather than type it and just make adjustments to the original search text to create additional search variations. Most of the time that works easily; sometimes it is easier to type what I want added.

To highlight the instances of WHO, I check the Highlight box (#3) for those that I want highlighted. The purpose of highlighting the text is so that as I edit the chapter, I can see that I have already made sure that the acronym/initialism has been spelled out and/or that the phrase has been checked (perhaps, e.g., I confirmed that the spelling or name is correct, such as “bevacizumab” or “chikungunya” or “Chinese National Biotec Group”). To change “World Health Organization” to “WHO”, I type “WHO” in the Replace Text field (#4).

Clicking OK causes SCR to do the designated tasks. When done, the results appear as shown here:

Highlighting and replacing text

Instances of “WHO” have been highlighted (#1, #3, and #4) and the two instances of “World Health Organization” (#2 and #3) have been deleted and replaced by “WHO.” Note, however, that the first instance of “World Health Organization” (#1), which is the instance that I had selected for the search term (see earlier image) remains. Note also that the deletions of “World Health Organization” and the additions of “WHO” are shown as tracked changes. If tracking is off, SCR turns tracking on, makes the changes, and turns tracking off; if tracking is on before it runs, it leaves tracking on when it is finished.

SCR performs another very valuable function in my editing: It helps me determine whether the acronym/initialism or the spelled-out version predominates. It is not unusual to get a report indicating the acronym/initialism appears, for example, five times and the spelled-out version appears six times. When that happens, as the editor I need to decide which form to use and which to replace. Of course, also entering the decision-making process is how I will justify my decision and whether I have an explicit instruction from the client that tilts the balance scales toward a particular response.

Tip: I also use SCR to determine whether a phrase appears in another form later in the text. For example, if I come across the phrase “tumor necrosis factor beta,” I will run SCR and add these 11 search terms using the “Add terms” feature:

  • tumor necrosis factor-beta [note the hyphen]
  • tumor necrosis factor–beta [note the en-dash]
  • tumor necrosis factor β
  • tumor necrosis factor-β
  • tumor necrosis factor–β
  • TNF-beta
  • TNF–beta
  • TNF-β
  • TNF–β
  • TNFβ
  • TNFbeta

When I get the report, I can determine whether any of the 12 phrases (the original selection plus the 11 added terms) appear later in the text and if they do, how often. That allows me to decide which form to use and which ones I need to change so that usage is consistent — and to make any necessary changes immediately. SCR is another tool in my consistency arsenal. Once I make the decision, assuming this is my first encounter with the phrase, I note my decision on the stylesheet and add the change to the Never Spell Word project-specific dataset (see The Business of Editing: The AAE Copyediting Roadmap V) so that the change is implemented in all subsequent chapters.

SCR is a more sophisticated form of Word’s Find & Replace function. Using Word’s Find & Replace requires multiple searches to be sure that most of the likely variations have been searched for. In addition, using Word’s Find & Replace doesn’t provide an easy way to mark text so that you know you have already checked it and it is okay.

Although the examples I use are nonfiction, SCR is a great tool for fiction editors. For example, you can search for character names and spelling variations (Mariah, Marya, and Maria are three spellings of the same name — although if the results came back Mariah = 100 and Maria = 63, I would query the author [and myself] whether these are the same character or different characters, and if the same character, which is the correct spelling).

Which leads us to…

It’s the rare manuscript that can go through editing and not have comments or queries inserted; in all of the hundreds of manuscripts I have edited, there have only been two or three. The Business of Editing: The AAE Copyediting Roadmap X discusses how I use, insert, and edit comments/queries during editing.

Richard Adin, An American Editor

April 10, 2017

The Business of Editing: The AAE Copyediting Roadmap VIII

Although it seems from the volume of the posts (this being the eighth in the series) that I have spent a lot of time on the manuscript but not gotten very far along the road, the opposite is truer: All that has gone before, with the exception of editing the reference list, took very little time. It takes longer to describe my steps than to perform them.

Each of the previous steps were necessary in my methodology as preludes to getting me to the point where I actually edit the manuscript. Now it is time to discuss some of the things done while actually editing the manuscript. I begin with reference renumbering.

Reference Renumbering

Not all manuscripts require reference renumbering, but a significant number do. The last major project I completed had 82 chapters made up of 10,000 manuscript pages and thousands of references (several chapters had more than 1000 references and many had between 500 and 900 references; the entire project had more than 21,000 references). Of those 82 chapters, 76 required reference renumbering; quite a few required renumbering beginning within the first 10 references (and one chapter had a half-dozen references that had to be inserted before reference 1).

Even if it turns out that a chapter’s references do not require renumbering, I need some way to make sure that references are called out in order; it is not unusual to have earlier references recalled out so that there is a sequence like this: 21, 22–24, 25, 26, 23, 27. I used to try to track the reference numbering and renumbering using pencil and paper; then I graduated to using an Excel spreadsheet. Both methods worked but they were cumbersome and time consuming. In addition, there wasn’t an easy way, in a chapter that required extensive renumbering, to quickly and easily track the renumbering.

Below is a sample page from a report generated by the References # Order Check macro (you can make the image, as well as other images in this essay, larger by clicking on the image). The format of the report is as follows: In the first shown entry (53,60), 53 is the original reference number as assigned by the author and found in the original reference list; 60 is the renumber value, that is, what was once numbered 53 is now renumbered as 60. As you look at the sample, you will see some numbers are followed by explanatory comments. If you would like to see the complete report, it is available for download from wordsnSync. The file is a PDF named Sample Reference Renumbering.

Reference Renumber Report

Reference # Order Check

The way I track references now is with EditTools’ Reference # Order Check macro, shown here:

The Renumbering Macro Dialog

For details on how this to use this macro, see Reference # Order Check. For purposes of this essay, there are only a couple of things to note. First, when I come to a reference callout in the text, assuming it does not need renumbering or a comment, I click on the corresponding number in the left numbering field (#A in image above). Doing so let’s me track what the next callout number should be. For example, if I have clicked on 1 to 7, I know the next numbered callout should be 8. If it is, I click 8; if instead it is 10, then I know I need to renumber. Renumbering is done by clicking in the blank field next to the number 10 in the main Renumber: field (#B in image). That will put the 10 in the Original: field (#C in image) and I enter its new number — 8 — or a comment or both in the Renumber: field (also at #C) and click Modify. The new number or the comment or both will appear in the main field (#B) opposite 10, and 8 will be removed from the left numbering field (#A). If the next callout is number 8, I repeat the renumbering process and renumber 8 as 9. And so it goes.

The Reference # Order Check macro does much more to help with numbering/renumbering, but a discussion of what else it does isn’t needed here. Take a look at the report the macro generates (see the complete Sample Reference Renumbering); I send a report to the client with every chapter/manuscript that requires reference list renumbering.

Managers on the Desktop

I do one more task before beginning actual editing: I open Bookmarks and the Managers for Toggle Word and Toggle Word Specialty. I also open Click List. I keep these open on one of my monitors (I use a three-monitor setup) because these are things I access frequently. With some projects, I also keep open the Never Spell Word Manager. In a large project, I will keep the NSW Manager open as I edit the early chapters, but with later chapters, I only open it when needed.

Bookmarks have already been discussed (see The Business of Editing: The AAE Copyediting Roadmap IV). Click List lets me insert items with a single click. Take a look at the Click List image below. In the image, the Symbols tab is showing. Before Click List, if I needed to insert a division sign (÷), I had to open Word’s Symbol dialog, search for the symbol, and double-click it to insert it into the document. It took time — sometimes a lot of time, sometimes only a little time — to find the symbol I needed. With Click List, I do that search once, add the symbol and my own name for it using the Click List Manager, and thereafter I insert it with a single mouse click from Click List. The Click List can be used for just about anything, from a symbol (e.g., ä or ≈ or Ǻ) to a lengthy phrase (e.g., including the opening space, “ of total antigen per dose” or “References for this chapter are available at Xxxxx.com.”). Click List is an excellent example of creating the wheel once and reusing it.

Symbols Tab in Click List

Toggle Word

Of all the macros I use during editing, none is more valuable than the Toggle Word macro. The Managers for Toggle Specialty and Toggle Word are shown here:

Toggle Word and Toggle Word Specialty Managers

The Toggle macro lets me select a word or phrase or acronym/initialism and change it quickly, easily, and, most importantly, accurately. Although I can type, I still make lots of typing errors. For example, it isn’t uncommon for me to type chatper instead of chapter. In that case, autocorrect takes care of the error, but things get dicier when I need to type N,N-diethyl-3-methylbenzamide. I may not notice a mistyping, which would be a tragedy, but even more tragic — for me — is the time I need to spend to type it, check it to make sure it is correct, and correct it if wrong. A couple of clicks is much better — quicker, easier, more accurate, and profit-enhancing.

Toggle works with tracking on, so I can undo at any time. Toggle also can give me options. For example, N,N-diethyl-3-methylbenzamide is the chemical name for DEET. When I am editing a manuscript, my clients want acronyms and initialisms spelled out at first mention (unless the style dictates that a particular acronym/initialism does not have to be spelled out, which is usually the case with, e.g., HIV/AIDS). So, when I come across the first instance of DEET in the manuscript, I place my cursor in or I select DEET and press my shortcut key for Toggle. The following dialog then appears:

Toggle Can Offer Options

Toggle displays my options based on what I have entered in the dataset. (If there are no options, it just makes the change that is in the dataset.) It is important to note that Toggle checks all of the datasets that appear in the Toggle Manager as well as the designated Toggle Specialty dataset, not just the dataset for the topmost tab. The image of the Toggle and Toggle Specialty Managers above shows 11 datasets — one for each tab plus the specialty — and when I run Toggle, it checks all of them for the selected word and displays all of the options. I choose the option I want and click OK. The word or phrase is replaced, no typing involved.

I keep the Toggle and Toggle Specialty Managers open as I edit so I can add new words to the datasets. The idea is to create the wheel once and reuse it; Toggle is a macro that lets me do that during editing.

Hotkeys: Worth Noting & Doing

EditTools macros are intended to make editing quicker, easier, more accurate, and more profitable. Consequently, easy access to regularly used macros is important. Most of the macros in EditTools can be assigned to keyboard shortcuts or Hotkeys. This is easily done by either clicking on the Setup Hotkey button, which is generally found at the bottom of a macro’s Manager, or by clicking the Hotkeys menu in the Preferences section of the EditTools toolbar.

I have assigned Hotkeys to those macros and managers that I use frequently. Because I keep the Toggle Word Manager open as I edit, it does not have an assigned hotkey — it is opened once and left open; in contrast, the Toggle macro is assigned a hotkey because it is not a macro that is (or can be) kept open but it is accessed frequently. Examples of other macros I have assigned to hotkeys are Enhanced Search, Count, & Replace; Smart Highlighter; and Insert Query. You can (and should) customize Hotkeys to fit your needs.

Moving On

Another macro I use often during editing is Enhanced Search, Count, and Replace, which is the subject of The Business of Editing: The AAE Copyediting Roadmap IX.

Richard Adin, An American Editor

April 3, 2017

The Business of Editing: The AAE Copyediting Roadmap VII

My approach to editing began with creating a stylesheet and cleaning extraneous and unwanted typing mistakes from the document (see The Business of Editing: The AAE Copyediting Roadmap II), moved through tagging the manuscript by typecoding or applying styles (see The Business of Editing: The AAE Copyediting Roadmap III) and inserting bookmarks for callouts and other things I noticed while tagging the manuscript (see The Business of Editing: The AAE Copyediting Roadmap IV), to creating the project- or client-specific Never Spell Word dataset and running the Never Spell Word macro (see The Business of Editing: The AAE Copyediting Roadmap V). The last stop was using wildcards to fix reference formatting problems, running the Journals macro to correct incorrect journal names, and editing the reference list (see The Business of Editing: The AAE Copyediting Roadmap VI). Now it’s time to tackle duplicate references using the Find Duplicate References macro.

Ancient History

Until recently, finding duplicate references was difficult and very time-consuming. I often deal with reference lists of 300+ references, with many lists running between 500 and 800 references and some running close to 2000 references. Before I created the Find Duplicate References macro, the only way I had to check for duplicate references in a numbered reference list was to use Word’s Find and do two or three different searches based on the same reference. One search might be on author names, another on article or book title, and a third on the cite information (i.e., journal name, year, volume, and pages). Unfortunately, many authors are sloppy with how they cite references so that the same reference is cited slightly differently each time it is cited. Sometimes a reference is cited completely, other times a reference is missing material.

Careful editing of references solved part of the problem, but duplicates of each reference still had to be searched for individually. Time — and profit — flew away.

Today’s Approach: Find Duplicate References

The process was taking too much time and costing me too much profit. I needed a better solution, which led to EditTools’ Find Duplicate References (FDR) macro, a much quicker and better solution to the problem of finding duplicate references.

As good as FDR is at finding duplicates (and from the heavy use I gave it in my last project, which project had more than 21,000 references in total, I know it is very good), it is important to remember that FDR, like other macros, is dumb — it will find only exactly what it is told to find, not something close. If two entries in the reference list are identical except that one has an extra space, FDR might not tag them as possible duplicates because of that extra space. Similarly, if the references are identical except that one uses a colon to separate portions of the article title and the other uses a dash, they will not be tagged as duplicates. Even the dashes have to be identical. For example, a page range that is identical except that one uses a hyphen as a separator and the other an en-dash will result in the cites not being tagged as identical. Again, close only counts in horseshoes.

Tip: Because the macro looks for matches within set number of characters, it is occasionally worthwhile to run the macro more the once using a different number of characters as the search parameter. The macro lets you choose 24, 36, 48, 60, 72, 84, 96, 108, or 120 as the number of characters in the search string. Consequently, if you choose 96 characters and two references are identical except that one uses an em-dash and the other uses an en-dash in the article title, the macro will not find them as duplicates. (This is why the macro does two passes — one from the beginning of the reference forward and one from the end backward — in case there is a match from one direction even if not from both directions.) Changing the search string length to 72 might find the duplicates if the dashes appear as the 73rd character or later. Of course, it may still not find the duplicates if the opposing characters still appear within the search string length. The macro is dumb; the characters within the search string must be identical.

Moving References

The dialog that appears when FDR is run, which is shown below (you can make the image, as well as other images in this essay, larger by clicking on the image), provides detailed information about the macro. As I noted previously, it is my habit to move the reference list to its own file. I do this for several reasons: First, the Journals macro runs more quickly because there is less material it needs to check.

Second, if the manuscript requires my using Superscript Me (see The Business of Editing: The AAE Copyediting Roadmap VI), it eliminates the possibility that Superscript Me will make unwanted changes to reference cites (e.g., changing 1986;52(14):122 to 1986;5214:122 or 1986;5214:122).

Third, it makes it easier to renumber and/or add or delete references during editing of the manuscript (I use three monitors and have found it is easier and quicker to access and edit the references when the text is open on one monitor and the reference list is open on a second monitor).

Fourth, the Find Duplicate References macro does several things to the document on which it will run before running, namely, save the current document, create a copy of the current document, remove any highlighting and queries/comments, and accept all changes (see #1 in below image). The idea is that the duplicates will be found in the copy document but the editor will note them in the original document, which is the document that the client will see.

The Find Duplicate References dialog

The longer the reference list, the more important I think it is that the reference list is moved to its own document. (When I am done editing the manuscript, I reincorporate the reference list in the edited document. I turn tracking off in the manuscript and use Word’s Insert Text from File feature to reinsert the reference list with all its tracked changes. I then turn tracking back on in the manuscript and save the file.) But if you do not want to move the references, you can leave them where they are and use the Bookmarks buttons (see #4 below) to insert the required dupBegin and dupEnd bookmarks at the beginning and end, respectively, of the reference list. (These bookmarks are not needed if the reference list is in its own file.)

The FDR Bookmarks

Making Ready

The key to the Find Duplicate References macro is remembering that the macro only identifies information that is identical (see #2 in the FDR dialog image above). Consequently, after running the Journals macro and before running FDR, I edit the reference list, making the references consistent. All page ranges, for example, use an en-dash; every time the CDC is named as the author, the name is conformed to “Centers for Disease Control and Prevention (CDC).” In addition, I check URLs and add any missing information.

Finally, I tell the macro the number of characters I want it to match (see #3 in the FDR dialog image above; also see the Tip above). Because the macro is a two-pass macro, it will check that number of characters (including spaces) from the beginning of the reference forward (it ignores the reference number and begins the count from the first alphanumeric character that is part of the cite itself) and then from the end of the reference backward.

The Report

When done, FDR produces a “report” that it places at the beginning of the reference list that looks like this:

The FDR Report

When the report is generated I use Word’s Find Pane to check each entry. (For a more in-depth discussion of the process, see Find Duplicate References at the wordsnSync website.)

Marking Duplicates

As I go through the list of possible duplicates, I mark those I find that are duplicates. However, I do not want to make changes to the reference list at this point; I just want to mark the duplicates. To mark them, I do two things: First, I insert a standard comment using the Insert Query macro, replacing the underscore with the numbers of the references that are duplicates of the current reference:

Marking a Duplicate with Insert Query

I also insert a bookmark at each location using the Bookmarks macro. I use this format (see the highlighted text):

Using Bookmarks with Duplicate Cites

The bookmarks act as a check, as well as make it easier to deal with the duplicate references. When, for example, during editing of the text I come to the callout for reference 18, I can see — from the comment and the bookmarks — that three other references are identical to 18, namely references 72, 91, and 102. Should the author have numbered references out of order and called out reference 91 before 18, I can see at a glance which references are duplicates. The bookmarks let me easily navigate to each of the duplicate references; once I have deleted a duplicate reference, I can delete its bookmark. The bookmarks provide an easy way to track which duplicates remain.

Recording & Reporting Duplicates

I also mark the information in the Reference Number Order Check macro (which is the subject of The Business of Editing: The AAE Copyediting Roadmap VIII). The Reference Number Order Check macro can provide my client with a report showing which references were deleted as duplicates and what those references were renumbered as. A sample report is shown here:

Sample Report of Duplicate References

As the sample report shows, references 78 (#5) and 201 (#6) were deleted and all callouts numbered 78 were renumbered as 19 and all callouts numbered 201 were renumbered as 85.

Find Duplicate References works very well. In one chapter I edited in a recent project, the macro found 23 duplicate references in a 700-entry reference list (one reference was duplicated five times!). It took the macro seconds to find those duplicates; had I looked for them without using FDR, it would have added hours to the project and turned the project into a profit-loser.

Richard Adin, An American Editor

March 27, 2017

The Business of Editing: The AAE Copyediting Roadmap VI

So far I’ve created a stylesheet and cleaned the document (see The Business of Editing: The AAE Copyediting Roadmap II), and tagged the manuscript by typecoding or applying styles (see The Business of Editing: The AAE Copyediting Roadmap III), inserted bookmarks for callouts and other things I noticed while tagging the manuscript (see The Business of Editing: The AAE Copyediting Roadmap IV), and created the project- or client-specific Never Spell Word dataset and run the Never Spell Word macro (see The Business of Editing: The AAE Copyediting Roadmap V). Now it’s time to tackle the reference list.

Fixing Reference Callouts

Before I get into the reference list itself, I need to mention another macro that I run often but not on all files — Superscript Me. Nearly all of the manuscripts I work on want numbered reference callouts superscripted and without parentheses or brackets. The projects usually adhere to AMA style. Unfortunately, authors are not always cooperative and authors provide reference callouts in a variety of ways, including inline in parentheses or brackets, superscripted in parentheses or brackets, with spacing between the numbers, and on the wrong side of punctuation. Superscript Me, shown below, fixes many of the problems. (You can make an image in this essay larger by clicking on the image.)

Superscript Me

I select the fixes I need and run the macro. Within seconds the macro is done. One note of caution: It is important to remember that macros are dumb — macros do as instructed and do not exercise any judgement. Consequently, even though Superscript Me fixes many problems, it can also create problems. My experience over the decade that I have been using this particular macro has been that the fixing is worth the errors that the macro introduces, even though they require manual correction during editing. The introduced errors are few, whereas the fixes are often hundreds.

Tip: Superscript Me is a powerful, timesaving (and therefore profitmaking) macro, but as noted above, it is dumb and just as it can do good, it can do harm — especially to reference lists. Before using Superscript Me on the manuscript, move the reference list to its own file. Doing so will ensure that Superscript Me makes no changes to the reference list, only to the main text material, saving a lot of undo work.

Wildcarding the Reference List

By this point, the reference list has been generally cleaned and moved to its own file.

Tip & Caution: Wildcard macros can be a gift from heaven or a disaster from hell. I like to do what I can to ensure they are a gift and not a disaster. Consequently, I move the reference list to its own file. I know I have said this before, but wildcarding is another reason for separating the reference list from the manuscript file. Often what I want changed in a reference list, I do not want changed in the primary text; similarly, what I want changed in the primary text, I do not (usually) want changed in the reference list. But like all other macros, wildcards are dumb and cannot tell text from reference list. It can do no harm moving the reference list to its own file and working on it separately from the main text, so be cautious and move it.

Individual problems, however, have not been addressed. I scan the list to see what the problems are and whether the problems are few or many. For example, if author names are supposed to be

Smith AB, Jones EZ

but are generally punctuated like

Smith A.B., Jones E. Z.

or in some other way not conforming to the correct style, I will use wildcard macros and scripts to correct as many of these “errors” as I can. Wildcards can address all types of reference format errors, not just author-name errors. For example, a common problem that I encounter is for the cite information to be provided in this format:

18: 22-30, 1986.

or

1986 Feb 22; 18: 22-30.

when it needs to be

1986;18:22–30.

These formatting errors are fixable with wildcards and scripts.

Scripts are like a supermacro. A script is a collection of many individual wildcard macros that have been combined into one macro — the script — and run sequentially. One of my reference scripts is shown here:

Wildcard Find & Replace Script

In the image, the active script file (#1) is identified and what it does (broadly) is described in the description field (#2). The wildcard macros that are included in the script and the order in which they will run are shown in the bottom field (#3). Included is a description of what each of the included wildcard macros will do (#4). For example, the first wildcard macro that the script will run will change Smith, C., to Smith C, and the second wildcard macro to run will change Smith, A.B., to Smith AB,.

The wildcard macros were created using the Wildcard Find and Replace (WFR) macro shown below. In the image, the example wildcard macro (arrow) is the same as the second macro in the script above, that is, it changes Smith, A.B., to Smith AB,.

Wildcard Find & Replace

Creating the macros using WFR is easy as the macro inserts the commands in correct form for you (for more information, see the online description of WFR). Saving the individual wildcard macros, assembling them into scripts, and saving the scripts, as well as running individual wildcard macros or scripts, is easy with WFR. (For some in-depth discussion of wildcards, see these essays: The Business of Editing: Wildcarding for Dollars; The Only Thing We Have to Fear: Wildcard Macros; and The Business of Editing: Wildcard Macros and Money.)

With some projects I get lucky and the authors only have a few references that are a formatting mess and when there are only a messy few, I fix them manually rather than run the macros.

Fixing Page Ranges

If the references are in pretty decent shape (formatwise) so that I do not need to run WFR, I will run the Page Number Format macro (shown below) to put the page range numbering in the correct format For example, the macro will automatically change a range of 622-6 to 622–626, 622–6, or 622.

Page Number Format

Making Incorrect Journal Names Correct

At long last it is time to run the Journals macro. As my journals datasets have grown, they have made reference editing increasingly more efficient. It takes time to build the datasets, but the Journals Manager (shown below) lets me build multiple datasets simultaneously.

The Journals Manager

As shown in the image, I can build five datasets (arrows) simultaneously. My primary dataset — AMA with Period — has 212,817 journal entries (see circled items).

Tip: Move the reference list to its own file to shorten the time it takes to run the Journals macro. The larger your journals dataset, the more time the Journals macro requires to complete a run. Each iteration of the Journals macro searches from the top of the document to the end as it looks for matches. Leaving the reference list in the manuscript means the macro has that much more to search. In a recent timing test of the Journals macro using my primary dataset and a 50-page document with 110 references without separating out the list, the macro was still running after 2 hours and was not near completion. Running the Journals macro with the same dataset and on the same reference list — but with the list in its own file — took less than 10 minutes. (Think about how long it would take you to manually verify and correct 110 Journal names.)

The Journals macro searches through the reference list for journal names and compares what is in the reference list against what is in the chosen dataset. If the name in the reference list is correct, the macro highlights it in green (#5), as shown below; if it is incorrect, the macro corrects it and highlights the change in cyan (#6). All changes are done with Tracking on.

The Reference List After Running Journals Macro

The Journals macro does two things for me: First, if the incorrect variation of the journal name is in the dataset, it corrects the incorrect journal name so that I do not have to look it up and fix it myself (see #6 above). If the incorrect variation is not in the dataset, the macro makes no change. For example, if the author has written New Engand J. Med but that variation is not in the dataset, it will be left, not corrected to N Engl J Med. When I go through the reference list, I will add the variation to the dataset so it is corrected next time. Second, if the journal name is in the dataset, it highlights correct names, which means that I know at a glance that the journal name is correct and I do not have to look it up (see #5 above).

It is true that the names of some of the more frequently cited journals become familiar over time but there are thousands of journals and even with the frequently cited ones with which I am familiar, correcting an incorrect name takes time.

It is important to remember that time is money (profit) and that the less time I need to spend looking up journal names, the more profit I make.

After I run the Journals macro, I open the Journals Manager (see above) and I go through the reference list, doing whatever editing is required and fixing what needs fixing that my macros didn’t fix. Because of the current size of my journals datasets, there aren’t usually many journal names that are not highlighted. When I come to one that is not highlighted either green (indicating it is correct) or cyan (indicating it was incorrect but is now correct), I look up the name and abbreviation in the National Library of Medicine online catalog and other online sources. When I locate the information, I add it and the most common author variations (based on my experience editing references for more than 30 years) to the five datasets via the Journals Manager.

I take the time to add the journal and variations because once the variations have been added, I’ll not have to deal with them again. Spend a little time now, save a lot of time in the future.

In addition to editing the references for format and content, I also keep an eye out for those that need to be removed from the reference list and placed in text — the personal communication–type reference — and for those that need to be divided into multiple references. When I come across one, I “mark” it using a comment. For example, using the Insert Query macro (which is discussed in the later essay The Business of Editing: The AAE Copyediting Roadmap X), I insert the comment shown below for unpublished material:

Query for Unpublished Material

When I come to the in-text callout during the manuscript editing, I move the reference text to the manuscript, delete the callout and the reference, and renumber using the Reference # Order Check macro (which is discussed in the later essay The Business of Editing: The AAE Copyediting Roadmap VIII).

Now that the Journals macro has been run and the references edited, the next stop on my road is the search for duplicate references, which is the subject of The Business of Editing: The AAE Copyediting Roadmap VII.

Richard Adin, An American Editor

March 20, 2017

The Business of Editing: The AAE Copyediting Roadmap V

I am now nearly at the point where I actually begin editing the manuscript itself. I’ve created a stylesheet and cleaned the document (see The Business of Editing: The AAE Copyediting Roadmap II), and tagged the manuscript by typecoding or applying styles (see The Business of Editing: The AAE Copyediting Roadmap III), and inserted bookmarks for callouts and other things I noticed while tagging the manuscript (see The Business of Editing: The AAE Copyediting Roadmap IV). Now it is time to create the project- or client-specific Never Spell Word dataset and then run the Never Spell macro.

Never Spell Word (NSW) lets me create project- or client-specific datasets. If I know, for example, that the client prefers “distension” to “distention,” I can, using NSW mark every instance of “distension” with green highlighting, which tells me that this is the correct spelling, and change every instance of “distention” to “distension,” which change will be made with tracking on and then highlighted in cyan to visually clue me that a change has been made (I can choose to make the changes with tracking off, but that is not something I ever do).

Tip: It is important to remember that the tab names, such as “Drugs,” in the Never Spell Manager, and in nearly all managers, can be changed to whatever name best suits your editorial business. Use the Change Tab Name button. The tab names that show when you install EditTools are placeholder names.

Highlighting is integral to EditTools. Highlighting attracts the eye and by using different highlight colors, I can, at a glance, tell whether I need to review or check something. Because of the types of books I work on, it is not unusual for Word to put a red squiggle under a word or phrase that is actually correct — it just isn’t in Word’s dictionary. Most editors would stop and check the squiggled word, but, for example, if I see it is highlighted in green, I know that it is correct and I do not have to check it — I know I have already checked the word and then added it to a tab in the Never Spell Manager.

The point is that NSW enables me to mark (via highlighting) items that are correct, items that need to be checked, items that are correct but may not be capitalized correctly, items that should never be spelled out, and items that should always be spelled out according to the stylesheet and client instructions. Some examples are shown in the image below (you can make this image, as well as other images in this essay, larger by clicking on image):

A Dataset in Notepad++

The datasets are text files. The above image shows a project-specific dataset that was opened in Notepad++ (Notepad++ is an outstanding free text editor that is a replacement for Microsoft’s Notepad). The * and $ preceding an entry indicate case sensitive and whole word only, respectively. For example (#1 in image above),

*$ms | cyan -> msec

means: find instances of “ms” as a lowercase whole word (in other words, “ms” but not, e.g., “forms” or “MS”) and change it to “msec.” What I will see in the manuscript is this:

Change Example

The cyan tells me at a glance that this has been changed by NSW. If the change is incorrect for some reason, I can reject the change, which is why I do it with tracking on.

I use NSW as a way to implement stylesheet decisions, as well as client preferences. An example is “F/M” (#2 in above image). The nice thing is that I do not need to format the entry. The Never Spell Manager, shown below, makes it easy — I just fill in the blanks, and if appropriate check one or both checkboxes, and click Add. I can easily correct an erroneous entry by double-clicking on it, correcting it, and clicking Update. And the Manager stays open and available until I click Close. With this Manager, I can make additions to any of the tabs.

The NSW Manager

I also use NSW as a way to mark things I already know are correct or incorrect and need changing so that I spend less doing spell checking tasks and more time doing higher-level editing. When I come across a new term, such as the name of a new organism, if appropriate I add it to one of the NSW datasets after I verify it so that next time it will be highlighted and, if necessary, corrected. For example, authors often type ASO3 rather than the correct AS03 (the first is the letter O then second is a zero). Having come across that mistake often, I added the instruction to change ASO3 to AS03 to my Commonly Misspelled Words dataset. Another example is the word towards. The correct spelling in American English is toward, so I added the word towards and the correction (toward) to an NSW dataset.

When I run the NSW macro, I am actually running more than what is contained in the Never Spell Words dataset — I can choose to run one, some, or all of the datasets represented by the tabs in the Never Spell Manager shown here:

Choosing Datasets

In this example, I am running all of the datasets except the Confusables dataset.

Tip: Using only the datasets that are applicable to the project allows the NSW macro to complete faster. This is especially true as your datasets grow.

I run the NSW macro over the main text; I do not run it over the reference list. My habit is to move the reference list to its own document after I style/code and do cleanup, but before I run NSW. The NSW macro requires the placement of a bookmark called “refs” at the point in the manuscript where I want the macro to stop checking text. Consequently, I do not have to move the reference list to a separate file if the list is after the material I want the macro to go over — I can just put the bookmark in the reference list head or in a line that precedes the list. I move the reference list to its own file because my next step will be to run the Journals macro, and that macro works faster and better when the reference list is in its own file, especially if the dataset is large as mine are (e.g., my AMA style dataset runs more than 212,000 entries).

As I said earlier, I keep the Never Spell Manager (shown above) open while I edit. Doing so lets me add new material to the various datasets as I edit the manuscript. The idea of the multiple tabs is to be able to have specialized datasets that are usable for all (or most) projects; for me, only the Never Spell Words dataset is project/client specific. When I come across the name of a study, for example, such as AFFIRM (Atrial Fibrillation Follow-up Investigation of Rhythm Management), I enter the information in the Studies/Trial tab dataset, because that is information that is neither project nor client specific.

I also keep open the Toggle Managers because when I come across something like the AFFIRM study I want to enter it into the appropriate Toggle dataset, too. But the Toggle macro is the subject of a later Roadmap essay (The Business of Editing: The AAE Copyediting Roadmap VIII).

After running NSW, it is time to turn attention to the reference list. The Journals macro and the Wildcard Find and Replace macro are the subjects of The Business of Editing: The AAE Copyediting Roadmap VI.

Richard Adin, An American Editor

March 13, 2017

The Business of Editing: The AAE Copyediting Roadmap IV

I ended The Business of Editing: The AAE Copyediting Roadmap III with a discussion of Style Inserter and with my repeating an earlier comment about how the smart editor creates the wheel once and reuses it instead of recreating the wheel with each new project. (I do understand that if you are doing one-off projects it is more difficult to create a reusable wheel, but there is a lot to editing that is repetitive across projects, even across one-off projects.)

One of the tools that I tried to use in my early years of editing was Word’s bookmarks. I would come across something that I thought I was likely to need to relook at as editing progressed and I would add a bookmark. The problem was — and remains — that Word’s bookmarking is primitive and not all that helpful. Of what value is a list of dozens of bookmarks that are nondescriptive, can’t be organized, and are so similar that it is hard to tell which is the one you need to go to? Before EditTools’ Bookmarks, I found using bookmarks to be very frustrating. (For previous essays on bookmarks, see The Business of Editing: Using & Managing Bookmarks and Bookmarking for Better Editing.)

EditTools’ Bookmarks are much more powerful and usable than the standard Word bookmarks. A detailed description of the Bookmarks macro is available at the wordsnSync website; here I want to address how I use bookmarks in editing.

My first use is to mark callouts of display items in the text. It is pretty easy to recall that Figure 1 was called out in the text when a manuscript has only one figure, but if a chapter is 50 pages long and has ten figures and six tables (and perhaps other display items), using bookmarks makes it easy to confirm that all are called out in the text. I insert a bookmark at the first instance of an in-text callout of a figure or table (see arrows [#1] in figure below) (you can make this image, as well as other images in this essay, larger by clicking on the image).

EditTools' Bookmarks dialog

EditTools’ Bookmarks dialog

When I get to the section of the manuscript that has, for example, the figure legends, I match the callout bookmark to the figure legend — that is, when I am styling/coding the legend to Figure 3, I make sure that there is a callout in the text for Figure 3 by looking at the above dialog to see if there is a bookmark fig 003. If there is, I use Move Bookmark (#2 in above figure) to move the bookmark from the callout to the legend. I do this is so that when I am editing the manuscript (rather than styling/coding), I can go from a figure’s callout to its legend (I insert a temporary pause bookmark at the callout so I can easily return to that spot), edit the legend and make sure the figure and the text are aligned (addressing the same issue), and then return to where I had paused editing. If there is no bookmark for the callout, I search the text for it; if it remains unfound, I query the author. Using bookmarks at this stage of the editing process gives me an easy way to check that all display items are called out in the text.

I also use bookmarks to mark something that I think I may need to check later. For example, if I see that references are going to be renumbered and that Table 1 includes reference callouts, I can insert a bookmark similar to that shown here (#3):

Descriptive bookmarks

Descriptive bookmarks

I keep the Bookmarks dialog open while I edit, so reminders like this are always visible and it is easy to add a bookmark. If a bookmark will be used repeatedly, like the “fig” bookmark, I create a custom button (#4) so that I can insert it with a single click, rather than repeatedly typing. (See Bookmarks at wordsnSync for more information about the custom buttons.)

There are two other things I do with bookmarks that help with editing. First, when I have edited a display item, such as a table, I rename the bookmark — I do not delete it because I may need to return to the item and this is an easy way to navigate. Renaming is easy and I have chosen a default naming convention as shown below (#5).

My default renaming convention

My default renaming convention

This renaming convention tells me that I have edited the display item, which I would not have done if the display was not called out in the text. It also leaves me a bookmark that I can use to navigate to the item in case there is a need to make a correction or add a comment that surfaces after additional editing. (You can create your own default naming convention or manually rename the bookmark using the Bookmark Rename dialog shown below. Using the Rename dialog you can create standardized renaming conventions and choose among them which is to be a default. You can choose a prefix or a suffix or both, as I did. The advantage to creating a default is that in three mouse clicks the renaming is done: one to select the bookmark to rename, one to click Rename, and one to click OK — quick and easy. Try renaming a bookmark using Word’s Bookmark function.)

Bookmark renaming dialog

Bookmark renaming dialog

Bookmarks that I no longer need, I delete. I like to keep lists that I need to check to a minimum. Thus, for example, once I have rechecked the reference numbering in Table 1, I will delete the bookmark that acts as both a reminder and a marker.

In my editing process, I use bookmarks extensively, especially as reminders to do certain tasks before I decide that the editing of the manuscript is complete — essentially a to-do list for the document I am editing. Unlike Word’s Bookmarks, EditTools’ Bookmarks lets me use plain-English descriptive bookmarks and organize them. Note that the bulleted “Recheck” bookmark appears as the first entry and the “x” (to signify edited) renamed bookmark has moved to the end of the list.

The next step in my editing path is to create my project-specific Never Spell Word dataset. When I first begin a project, this dataset may have only a few items in it, but it grows as the project progresses. Never Spell Word is the subject of The Business of Editing: The AAE Copyediting Roadmap V. Never Spell Word is a key item in my editing roadway.

Richard Adin, An American Editor

March 6, 2017

The Business of Editing: The AAE Copyediting Roadmap III

A manuscript is generally “tagged” in one of two ways: by applying typecodes (e.g., <h1>, <txt>, <out1>) or by applying styles (e.g., Word’s built-in styles Heading 1 and Normal). My clients supply a list of the typecodes they want used or, if they want styles applied, a template with the styles built into the template. Occasionally clients have sent just a list of style names to use and tell me that, for example, Heading 1 should be bold and all capitals, leaving it to me to create the template. The big “issue” with typecoding is whether the client wants both beginning and ending codes or just beginning codes; with EditTools either is easy. Some clients want a manuscript typecoded, but most clients want it styled.

Typecoding

If the client wants typecoding, I use EditTools’ Code Inserter Manager (shown below) to create the codes to be applied. Detailed information on Code Inserter and its Manager is found at wordsnSync. I will focus on EditTools’ Style Inserter and its Manager here because that is what I use most often. Code Inserter and Style Inserter and their Managers work very similarly. Describing one is nearly a perfect description of the other. (You can make an image in this essay larger by clicking on the image.)

Code Inserter Manager

Code Inserter Manager

Style Inserter

Style Inserter relies on a template. Usually the client provides a template, but if not, the client at least provides the names of the styles it wants used and a description of the style (e.g., Heading 1, All Caps, bold; Heading 2, title case, bold; etc.) and I create a template for the client. Occasionally the client uses Word’s default styles. Once there is a template, I open Style Inserter Manager, shown below, and create styles that the Style Inserter macro will apply.

Style Inserter Manager

Style Inserter Manager

As you can see, Style Inserter Manager gives me a great deal of control over the style and what it will look like. When styles are applied in Word, one has to go through several steps to apply it. Style Inserter is a one-click solution. The information I entered into the Manager is translated into the Style Inserter macro (shown below). I organize the dialog how it works best for me and keep it open as I style the manuscript. A single click applies the style and can move me to the next paragraph that requires styling.

Style Inserter

Style Inserter

(If you do typecoding, you can tell the Code Inserter Manager whether you need just beginning codes or both beginning and ending codes. Like Style Inserter, once you have set up the coding in the Manager, you only need a single click to enter a code. As shown below, the macro looks and acts the same as Style Inserter. You do need a second click to enter an ending code because it is not always possible to predetermine where that end code is to be placed.)

Code Inserter

Code Inserter

Take a look at the Style Inserter Manager shown earlier. There are several formatting options available but there are two I want to especially note: Head Casing (#A in image) and Language (#B).

I am always instructed to apply the correct capitalization to a heading. It is not enough that the definition of the style applied to the head includes capitalization; the head has to have the correct style applied and the correct capitalization. If None is chosen, then however the head is capitalized in the manuscript is how it remains. If the head should be all capitals, then I would choose Upper from the drop down list (shown here):

Head Casing dropdown

Head Casing dropdown

Whatever capitalization style I select will be imposed on the head as part of applying the style. No extra steps are required once the capitalization requirements are made part of the style in the Manager. Title case capitalization is governed by the Heading Casing Manager, which is found in the Casing menu on the EditTools toolbar.

Head Casing

The Heading Case Manager (shown below) has two tabs: Head Casing and Words to Ignore. In the Head Casing tab you enter words or acronyms that are to always be all capitals or all lowercase. In addition, you indicate if that “always rule” is to be ignored. The Words to Ignore tab is where you list words that should be ignored when casing is applied, such as Roman numerals and symbols or acronyms like “miRNA”. Thus, for example, even though the instruction is that the head is to be all capitals, the “mi” in “miRNA” will remain lowercase. This works the same in the Code Inserter Manager.

Head Casing Manager

Head Casing Manager

Setting the Language

The Language option (#B in the Style Inserter Manager image above) is also important. One of the frustrating things for me is when I am editing and I realize that the authors (or some gremlin) set the paragraph’s language as Farsi and when I correct a misspelling it still shows as a misspelling because I am using American English. The Language option lets me choose the language I want applied (see image below). Selecting the language from the dropdown (here “English U.S.”) and also checking the Language box, will incorporate into the style that will be applied by Style Inserter the instruction to set the language to what I have chosen — overriding the language attribute that is present in the manuscript.

Language Option in Style Manager

Language Option in Style Manager

I make it a habit to incorporate the language instruction in every style. It saves me from wondering why the red squiggly line appears under a correctly spelled word, thereby removing an obstacle that slows editing (and lowers profitability). This works the same in the Code Inserter Manager.

Bookmarking While Styling

As I style the manuscript, I also insert bookmarks using EditTools’ Bookmarks. The bookmarks let me track elements of the manuscript. This is especially true because with EditTools’ Bookmarks I can create meaningful bookmarks, which is where we will start in The Business of Editing: The AAE Copyediting Roadmap IV.

Combo Click

But before we get to Bookmarks and the next essay, I want to mention another EditTools macro: Combo Click. I have found that when I do certain tasks I like to have certain macro managers open. Combo Click, shown below, lets me choose my combination of managers that I want open. Instead of having to click on each manager individually, I click on the combination in Combo Click and those managers open.

Combo Click

Combo Click

Creating the combinations is easy with the Combo Click Manager shown here:

Combo Click Manager

Combo Click Manager

Reusing the Wheel

The idea is to do as much work as possible quickly and with a minimum of effort. When I first set up, for example, Style Inserter, it takes a few minutes that I would not have to spend if I simply used the standard Word method. So editing chapter 1 may take me a few minutes longer than if I weren’t creating the Style Inserter dataset, but all subsequent chapters will take me less time than without Style Inserter. My point is that the smart businessperson looks at the macro picture, not the micro picture. EditTools works using datasets that the editor creates. Those datasets are the wheels — you create them and reuse them.

The next project I do for the client means I can load a previously created Style Inserter dataset and I can add those styles that are not already included and delete those that are no longer needed — a faster method than starting from scratch — and then save the new dataset under a new name.

The Business of Editing: The AAE Copyediting Roadmap IV picks up with Bookmarks and how I use them to help me remember to perform certain tasks and to navigate the manuscript.

Richard Adin, An American Editor

Next Page »

Blog at WordPress.com.

%d bloggers like this: