Tag Archives: websites

Resources round-up: Non-book formats

Welcome to this round-up of resources compiled by the CIEP. This time, we look at working with non-book formats, from board games to corporate communications. We have divided our picks into:

  • free CIEP resources
  • one great book
  • blogs and websites.

Free CIEP resources

A dive into the archives of the CIEP blog gives you a taste of the strange and wonderful formats that can be edited, including multiple-choice questions (there’s even a new free fact sheet about this) and puzzles.

We all learn from applying editorial principles to content beyond books, and this enriches our editing if and when we edit books again – although who would blame us for deciding to edit puzzles forever? Rachel Lapidow, who wrote for us about how creating style sheets for role-playing games (RPGs) could shed light on fiction editing, describes how she used a style sheet from her own editorial training at the University of California, San Diego, as a basis for the style sheets she developed for the games she worked on. She recalls how her knowledge and practice came full circle: ‘One of my instructors from UC San Diego asked me to share one of my RPG style sheets for her to use in her class. It’s a bit surreal to imagine future copyeditors looking at a style sheet I created while they’re learning how to utilise this tool. But it’s also pretty darn cool.’

Corporate communications can be cool, too, of course. The CIEP blog has articles about corporate editing, business content, brand voice and how to work with SEO if you’re an editor or a proofreader.

One great book

Unlike the CIEP blog, our book pick isn’t free; however, it’s well worth its £30 price tag. The Copyeditor’s Handbook: A guide for book publishing and corporate communications by Amy Einsohn and Marilyn Schwartz (read the CIEP review of this handbook and the accompanying workbook) is packed with useful information about what copyediting is and how to do it. It’s as relevant for copyediting business content as it is for copyediting traditional books, as the authors make clear in the introduction: ‘Copyediting is one step in the iterative process by which a manuscript is turned into a final published document (e.g., a book, an annual corporate report, a newsletter, a web document).’

The Copyeditor’s Handbook is written from a US perspective, but wherever you are in the world, if you’re working on corporate content it will help you. Just break out the sticky notes and spend time familiarising yourself with which of its chapters and sections you’ll need, as it’s dense and detailed.

Book marked with sticky notes

Blogs and websites

Words pop up everywhere, and where there are words, there is editing and proofreading (or there should be, for best results). Blogs from editing associations and dictionaries have covered formats as diverse as comic strips, association magazines and surveys.

More useful, sometimes, are articles on issues that are likely to come up when editing and proofreading non-book formats. For editors of websites and other formats that cite URLs, there’s practical advice on taming messy URLs from the Chicago Manual of Style, and information on how web design and branding choices can affect a reader’s ability to access text from ProCopywriters.

Working with contributing writers can be a challenge in business editing. Alison Harmer offers ten tips for keeping corporate communications on track; and June Casagrande makes a convincing case for using plain language, just in case you’re dealing with contributors who are fond of writing in a flowery manner.

As a general principle, if you’re editing beyond traditional books, make sure you look beyond traditional editing blogs. The Web Accessibility Initiative is excellent. The extensive ProCopywriters blog is absolutely free, written by people who write for a living and want to showcase their skills, and gives great tips on areas such as structuring online content, cutting fillers in writing and tone of voice that will be particularly useful if you’re editing business content.

About the CIEP

The Chartered Institute of Editing and Proofreading (CIEP) is a non-profit body promoting excellence in English language editing. We set and demonstrate editorial standards, and we are a community, training hub and support network for editorial professionals – the people who work to make text accurate, clear and fit for purpose.

Find out more about:

 

Photo credits: comic books by Eric Mclean on Unsplash, book marked with sticky notes by cottonbro studio on Pexels.

Posted by Eleanor Smith, blog assistant.

The views expressed here do not necessarily reflect those of the CIEP.

Forum matters: Creating and editing web content

This feature comes from the band of CIEP members who serve as forum moderators. You will only be able to access links to the posts if you’re a forum user and logged in. Find out how to register.

Posts on this topic that are more than a year old might be of only historical interest, given how fast technology changes. The threads referred to in this article have been selected because they link pretty directly to work on websites, but don’t forget that issues of accessibility also apply to (or can be found in relation to) other media, such as PDFs.

Your own website

Although many editors and proofreaders rely on social media to network and expand their business, there is no doubt that having your own website helps establish your professionalism and is a good place for information about you that may get lost on Facebook and Instagram, or when LinkedIn and Twitter revamp their algorithms, or a newcomer takes people up another highway. One member’s request, Advice needed: moving from self-publishing to traditional fiction editing, ranged far and wide and pointed to just that conclusion.

Even if you’ve embraced the idea of developing a website it can be a slog, and a quick reach-out via the forums has kept members on track (‘How best to prioritise?’). After deciding to use a website design company, forum members have asked for recommendations, in threads entitled ‘website’ and ‘Web hosting and domain registrars’. Even that tricky sub-subject of emails has been covered in Email hosting recommendations.

Many CIEP members create and manage their own websites and have shared hard-earned advice on sites and specifics. You may already have chosen a provider, but if you are thinking of managing your own website then maybe you should have a look first at: Squarespace help; Creating a website then Websites again; Portfolio on WordPress website and New member & request for advice.

Members have asked each other for a quick review of their new or revamped websites (see Quid (I proofread your website) pro quo (you proofread mine) and quick website check) and for help on specifics such as T&Cs and Domain Name Extensions, or about the principles of Pricing and its absence on editor websites and the Use of first-person in freelance websites. The number of replies does vary, and sometimes the first one nails the answer, while at other times the discussion ranges so far you feel you’ve attended a mini-course in the subject – see Struggling to be competitive.

There are some topics that apply to more than websites but will certainly add a professional gloss, such as a source to spruce up the background of your profile pic in Useful website to create/edit profile pics or useful advice on accessibility in Text colours and backgrounds – best and worst for legibility? and Q about hyperlinks in Forum signature.

Laptop and notebook

Working on other websites

You don’t have to have created a website to be able to work on one (although it does help), but it is worth doing some training on the subject. CIEP offers two specific courses: Editing Digital Content and Web editing. But the forums are also up there when it comes to learning. We’ve all had an itch when we’ve spotted some bad practice and asked ourselves, should I say something? Read the thread and then decide.

You’d think a business would see editing their website as a no-brainer, but sometimes getting at the content can be tricky. Copyediting of websites and general advice on editing a website offer some useful insights and links.

SEO and accessibility are two aspects that you really need to get to grips with if you are going to offer a good service to website clients, and the forums are full of good advice on: best font/typeface for emails; quote marks and other punctuation for easy reading and accessibility; Rewording a bullet list for a website; Should numbers be spelled out in Websites?; Providing hyperlinks: best practice?

Good luck with your own and other websites. And don’t hold back on developing your skills and sharing your experiences through the CIEP forums.

About the CIEP

The Chartered Institute of Editing and Proofreading (CIEP) is a non-profit body promoting excellence in English language editing. We set and demonstrate editorial standards, and we are a community, training hub and support network for editorial professionals – the people who work to make text accurate, clear and fit for purpose.

Find out more about:

 

Photo credit: laptops by Louise Viallesoubranne, notebook and laptop by Marissa Grootes, both on Unsplash.

Posted by Harriet Power, CIEP information commissioning editor.

The views expressed here do not necessarily reflect those of the CIEP.

Talking tech: Web editors – WYSIWYG or code?

In this Talking tech column, Andy Coulson discusses two types of web editing tools – WYSIWYG and code-based – designed for editing HTML (HyperText Markup Language) content on websites.

The October 2022 issue of member newsletter The Edit is about web editing, so I’m going to look at two types of web editing tools that are well suited to editing content on sites where the content is mainly in HTML (HyperText Markup Language). The content of a webpage is generally held as an HTML file. This is an unformatted (plain text) file that contains the text content and tags describing the function of the text (heading, paragraph, etc), which can then be used to format the text or potentially manipulate it. The tags appear in angle brackets, eg <H1>title</H1>.

However, the web has changed drastically over the last ten years or so and many websites don’t only use HTML. Most sites now separate out a lot of formatting information using CSS (cascading style sheets) files. Many sites also include JavaScript and other programming code to create interactive and dynamic elements on the page. When you are focusing on the content, not only can this be a distraction, but there is potentially a lot of scope to create problems. This is why, broadly, I am focusing on tools with good HTML support, although they can also deal with other files, such as CSS and active elements like JavaScript.

Many smaller websites are created using online website creator systems such as WordPress, Squarespace and Wix. These give you direct access to the content text, making for a simpler editing experience without losing access to the advanced features described above. They make extensive use of templates that can mask a lot of complexity. They will often offer the features I’ll describe in reviewing the two types of editor below. So it is worth checking if those have been used and if you can access the content through those systems.

Text or visual editing?

The two types of tool I am going to look at are code editors and WYSIWIG (what you see is what you get). I have picked two editors, one of each type, both of which are free. Most web developers will use commercial packages, such as Adobe’s Dreamweaver WYSIWYG editor, and code editors such as Eclipse and Microsoft’s Visual Studio, but for some basic text editing the following should provide sufficient tools to let you get started.

The code editor displays the HTML code, and to preview the webpage you need to view it in a browser. In contrast, a WYSIWYG editor gives you a live preview of the page as you edit. Many of these will provide templates to help you create a professional-looking website with minimal coding. Online web creators like WordPress and Wix also tend to offer these features. WYSIWYG editors often let you work directly on the graphical screen. For example, you can drag and drop an image onto a webpage and the editor will generate the appropriate code.

So, you might wonder, why would you use a code editor, particularly as WYSIWYG editors often incorporate a code editor? For me the answer is simplicity. Most code editors are smaller, simpler programs. There are fewer features, but that also means there are fewer to sort through to find what you want, and the learning curve can be less steep. The code editor, generally, uses less memory, which can still be an advantage even with today’s big memory machines. If you need to test the HTML files, you can do this with your web browser (or more probably web browsers, as things may work differently in Chrome and Firefox). Ultimately though, this will come down to personal choice.

None of the webpage editing tools (as far as I am aware) have features like Track Changes or comments. This means you will need to keep track of these separately. While you can add comments to HTML by enclosing them in ‘<!–’ and ‘–>’ tags, they are not that easy to see within the HTML file. Using these will depend on what your client needs.

Code: Notepad++

For this review I am going to use Notepad++, which is a very flexible general code editor with good HTML support. While this is not aimed purely at web editing, I think it is a clear and well-written program that is simply nice to use. It can be downloaded from here.

Screenshot from Notepad++

Notepad++ provides a relatively familiar interface to anyone who has used older versions (pre-ribbon) of Word. Much of the left-hand side of the menu and many of the buttons will be familiar too. The real strengths of a code editor are the features to help you read through the HTML (or other code) easily, such as code completion (where the editor recognises commands or tags as you type and completes them for you, reducing missed closing tags) and syntax highlighting (where tag names and the values associated with them are highlighted in different colours, allowing you to more easily read the text). Here I’ve used the Style Configurator in the Settings menu to tell the program this is HTML and select a colour scheme – for example, blue for tags and pale brown for text.

WYSIWYG: BlueGriffon

For this review I am using BlueGriffon, which you can download from here. It is based on the same rendering engine (the bit of software that turns the HTML and other code into a webpage) as the Firefox web browser.

BlueGriffon has a nice clean interface and typically opens with the webpage in WYSIWYG view. In the screenshot below, I have used the dual view that opens a code editor with the webpage view. You can work directly in the webpage view, so correcting spelling mistakes like ‘servive’ in the last line of ‘About Me’ is straightforward. As you move around the webpage view on the left, the elements are highlighted in the code editor.

Screenshot from BlueGriffon

Many of the basic formatting features are shown down the left-hand side of the screen and help you to add neatly formatted (and hence coded) content. Compared to Dreamweaver, BlueGriffon has a relatively simple interface and limited feature set. This can be an advantage, as in editing the content you will only need a small proportion of the features available.

I mentioned testing in different web browsers earlier, and one nice feature in BlueGriffon is the globe button on the toolbar. If you click on this it allows you to open the file using another application, typically a web browser. If you have maths or foreign language characters this is worth doing, as these are examples of things that will render differently on different browsers.

Summary

BlueGriffon is available on Windows, Mac and Linux, but Notepad++ is only available on Windows and Linux. There is an alternative, CotEditor, for Mac that offers similar features to Notepad++. All three of these are free to download, which makes them very practical for occasional use, but they also have sufficient features for more intensive use.

Quick tip: Site maps

Here’s a quick tip that may be useful when you are working with websites. If you need to check what pages a website contains you can create a site map. A site map can be used to help search engines understand your website, or for you to visualise the website’s structure. Essentially, it is a list of all the pages.

There are a number of site map generators on the internet; I have used xml-sitemaps.com. Here you enter the name of the homepage of the site and the system goes off and searches through all the branches of the website (or ‘crawls’ it, to use the technical term), generating a list of pages. You can then use this to check you have all the pages that need editing.

About Andy Coulson

Andy Coulson is a reformed engineer and primary teacher, and a Professional Member of the CIEP. He is a copyeditor and proofreader specialising In STEM subjects and odd formats like LaTeX.

 

 

About the CIEP

The Chartered Institute of Editing and Proofreading (CIEP) is a non-profit body promoting excellence in English language editing. We set and demonstrate editorial standards, and we are a community, training hub and support network for editorial professionals – the people who work to make text accurate, clear and fit for purpose.

Find out more about:

 

Photo credits: header image by publicarray on Pixabay, Notepad and BlueGriffon screenshots by Andy Coulson.

Posted by Harriet Power, CIEP information commissioning editor.

The views expressed here do not necessarily reflect those of the CIEP.

Definite articles: Working with websites

Welcome to ‘Definite articles’, a column devoted to the CIEP’s top internet picks, most of which are definitely articles. This time, our theme is working with websites – for clients and for yourself. The CIEP has recently published its own articles on working in digital formats, in ‘Flying solo: Focusing your website on your ideal client’, and ‘Talking tech: Web editors – WYSIWIG or code?’ If you’re a CIEP forum user, you can access our website-related forum wisdom in ‘Forum matters: Creating and editing web content’.

In this issue:

  • Client websites: Learn from the experts
  • Planning and creating your own website
  • Refreshing your site
  • Other platforms
  • If it all goes wrong

Client websites: Learn from the experts

Marketing tips

Websites act as shop windows. So when you’re editing what is essentially marketing copy, it’s worth learning from people who know about marketing. Copywriter Karri Stover, in ‘11 steps to effective website copywriting’, reminds us of the importance of plain language, understanding the reader, including essential information, and readability. On that last point, Stover links to a useful 2013 article by Carrie Cousins at Design Shack, ‘The importance of designing for readability’, which talks about design elements, from subheads (which should be simple, direct and frequent) to how hyphens can break readers’ concentration.

Understanding accessibility and SEO

If you’re working with websites, you should always have at least one tab open at the World Wide Web Consortium (W3C) Web Accessibility Initiative (WAI). This advises on web accessibility and is recommended as a resource on the CIEP’s Editing Digital Content course. Get started with ‘Easy checks – a first review of web accessibility’ and ‘Introduction to web accessibility’.

It’s also essential to have an understanding of SEO (search engine optimisation). Michelle Bourbonniere gives a useful overview of what it is and how to do it. Marieke van de Rakt of Yoast has also written a long blog about the importance of content in SEO. Trickery with links is long gone as a way to improve rankings. These days, SEO is firmly about quality content, as Marieke testifies.

Planning and creating your own website

Every website needs to be planned, and Malini Devadas’s podcast episode ‘How to create a client-focused business’ is a good start in working out how the elements of your offering, including your website, fit together. John Espirian adds to this by taking the long view with a 30-month mindset.

Whether you create your own website or outsource that process is a big decision. A blog by Startups explores the options. If you’re keen on doing it yourself, John Espirian discusses setting up your own website in an article from the archives that includes plenty of useful tips and links. However, as Michelle Waltzman suggests in ‘Stressed about your to-do list? 5 times you should outsource tasks’, if you keep putting it off, you don’t know where to start, or you’ve tried it and it’s gone very wrong, it might be worth considering asking someone else to help you.

Even if you outsource the creation of your website, you’ll have to write it. Apply the same marketing, accessibility and SEO principles that we covered in the ‘Client websites’ section above. You might also commission some photography. Sophie Playle describes how she did this in ‘Branding my editorial business: Working with a photographer’. If you’re working with images that are already created, take a look at Chicago Shop Talk’s article ‘Crediting images at an author website’ for principles and tips.

Once you’ve covered the broad brushwork of development, content and images, make sure the little things also look great, including any URLs.

Refreshing your site

If you created your website some time ago, it’s important to interrogate it every so often to ensure it’s working as hard as it can. Luckily, if we forget, ACES, the society for editing in America, keeps us on our toes with articles like ‘Is your website referral-worthy?’ by Molly McCowan and ‘When was the last time you updated your website?’ by Nate Hoffelder. Nate also wrote the helpful ‘18 questions to ask when refreshing your editor website’. If 18 questions are too many, Annie Deakins suggests six website features you should check.

One editor, Letitia Henville, recently went beyond checking and fixing to supplementing her current site with a digital tool for academics, which received 4,000 views in its first three days. Not everyone has the time or resources to do this, but Letitia includes a list of less ambitious alternatives: ‘blog post, webinar, infographic, video, app, tin-can phone or whatever other medium may reach your client population’. As tempting as the tin-can phone is, many editors find that their digital resource of choice is the humble blog, and if yours is ailing Louise Harnby has four ideas to fix it. Recently on Twitter, Lynne Murphy (@lynneguist) recommended a piece about how to keep online readers engaged in long articles. If your blogs are on the lengthy side, take a look.

Other platforms

Don’t forget Twitter, LinkedIn, Instagram, TikTok and Facebook as part of a digital content strategy. You can see Instagram at its best in ‘The 15 most Instagrammed bookstores in the world’. TikTok has recently been credited with changing the publishing industry as high-profile book lovers share their favourite reads with users. But if all these options make you feel dizzy, Mel Edits has some sage words about timelessness in ‘5 rules of content that will never change’.

If it all goes wrong

Finally, Chicago Shop Talk has helpfully published an article on how to ‘take back’ an online error that could be useful if you’re working with websites or on other digital platforms. One advantage of the internet is that amendment can be instant. In certain circumstances, though, amendments have to be acknowledged and explained, for example if a vital word like ‘not’ has been omitted in a prominent place in the original text, giving entirely the wrong impression and alarming people.

We’ll leave you to think up your own examples.

Thank you for reading. Why not follow the CIEP on Facebook, Twitter and LinkedIn for more useful content for editors and proofreaders?

About the CIEP

The Chartered Institute of Editing and Proofreading (CIEP) is a non-profit body promoting excellence in English language editing. We set and demonstrate editorial standards, and we are a community, training hub and support network for editorial professionals – the people who work to make text accurate, clear and fit for purpose.

Find out more about:

 

Photo credits: header by Sigmund, person with mobile phone by by Jonas Leupe, both on Unsplash

Posted by Harriet Power, CIEP information commissioning editor.

The views expressed here do not necessarily reflect those of the CIEP.