This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Writing

How to produce well-presented and well-edited documents

1 - From research to writing

In your work, you will find that research and writing are closely integrated

Writing essays is a central element of your work in languages, one that draws on all of the knowledge and all of the skills that you will acquire in the course of your degree. It is in itself a process of discovery.

What is a critical essay?

A critical essay is a means of advancing an argument, of making and justifying claims. A critical essay is shaped by and engages with existing knowledge of the material on which you’re working. A critical essay is objective and responsive all at once. A critical essay is always well documented, using the relevant style conventions. A critical essay is an exercise in persuasion more than it is the rehearsal of a personal point of view.

The essay as genre

The essay is a literary genre… The practice of writing is intrinsic to cultural debate and the essay is one of its central genres. Many influential writers on literature and culture rely on the essay as a means of intervening in contemporary society.

The essay is also a scholarly genre that informs and persuades. It combines information and argument, evalation and research. Because it draws on these distinct kinds of work, essay writing is your means of participating in informed debate. Writing, therefore, implies research and research implies immersion in sources, both primary and secondary.

Your essay, because it draws on primary sources, and on critical treatments of these, is like a scholarly work, and an important feature of the treatment of sources is that it is always explicit in literary essays.

Good writing

Because essays are as a rule relatively brief, they are often examples of writing that is at once polished and forceful. Good writing implies revision, refinement and dialogue: your own essays will form part of your debates with your teachers.

Research and sources in the essay

Research will form part of your work. Your essay is researched and written with a specific focus in mind, as defined by the topic on which you choose to write. This is what gives your essay its primary purpose — to give a thoughtful, engaged and engaging account of a specific set of issues. In your research as well as your writing, it is important always to ensure that what you have to say remains relevant to the topic. Make sure that you use reliable sources, especially secondary sources that are accurate as well as relevant.

An essay demands close reference to your primary sources. One of the important skills that you will acquire is to recognize just what elements of the text are relevant to the topic and that allow you to develop your own response to it. This is where you should make precise and telling references to specific parts of the work (always giving page references when you do so).

Quotations

There will be occasions when it is appropriate to quote from a text. For instance, you may want to discuss a particular passage closely, in which case it is useful to have the text in front of you and your reader. But remember that a quotation of itself does not necessarily demonstrate a point and make sure that the purpose of a given quotation, short or long, is always clear.

Quotations take a number of forms. An inline quotation is a brief extract from a source which is given in quotation marks, either within a sentence or introduced by a colon. A block quotation is a longer extract — more than forty words or so — and is again introduced by a colon, and presented as a separate indented paragraph.

Get your references right

In any academic work, you are expected to document your sources. This is the reason why it is important when doing your research to take careful note of the information, explanations, ideas and arguments on which you wish to draw in your essay. Your essay should always include references in the form of a footnote, and a complete list of all of the sources on which your argument depends in a bibliography at the end of your essay.

Quotation and citation

Be explicit in referring to your sources. Direct reference must always be made to a source on which you rely for information, explanations, ideas or arguments. In the case of quotations, this practice should come very readily to you, as you are making direct use of a source. There will also be occasions when you will cite a source without quoting from it. In these cases too, you must always include direct references to any source on which you rely for information, explanations, ideas or arguments.

2 - Structured documents

Learn to make the structure of your documents explicit

Writing forms an essential part of your work as a student of languages. Many of the different kinds of work that you will do use writing as their medium: research and taking notes; presentations; essays and dissertations; translations and other language exercises. Even day-to-day communications depend massively on keyboards and screens — think of email and all social media. Much of the writing you will do as students will involve the use of information technologies too and almost any variety of academic writing can make use of such tools.

An essay is a structured document

Take essay-writing as an instance. You will write many essays in the course of your studies and almost invariably these are nowadays produced using dedicated information technologies, typically word-processors. In some cases, they may be printed and read on paper; but equally they will be circulated electronically and read on screen. In either case, it pays to think about presentation as well as content — and to regard this as an aspect of the careful and precise thinking about language that is at the forefront of your work. In structured documents, these two aspects are interdependent.

Here is an image of what an essay might look like, using some placeholder text.

Elements of document and page design

Elements of document and page design

Several items of the structure of the document are immediately apparent. It contains body text, that is successive paragraphs of content, each of which has the same unjustified format. The first paragraph on the page is preceded by a heading in a different style. There are two block quotations, one of which appears to contain three lines of verse. The document contains two footnotes which are linked to the two block quotations, again in a different style, namely a smaller font size. These are the main visible elements of the design of the document. In addition, you can see two further elements that form part of the page design: a header and a footer, each containing information that will be repeated from page to page.

Make the structure of your document intelligible

These are some of the main components of a typical essay and an application like a word-processor allows you to make the structure of your essay explicit.

Using word-processors and other tools, you can mobilize typographical conventions to make the structure of your document clear.

A LibreOffice file

A LibreOffice file: running header and heading in small caps

Here, for instance, what are termed small capitals are used to denote headings as a structural element of the document. They are also used for headers and footers. Using the same style for all of these components makes the structured hierarchy of your document more intelligible, without multiplying visual variants to excess.

3 - Word-processors

Using word-processors to generate structured documents

The most widely used word-processor continues to be Microsoft Word, which is a well-documented application.

You can also consider using LibreOffice Writer for your work in languages for a number of reasons:

Both Word and LibreOffice Writer are typically used as applications installed in your computer. By contrast, Google Docs allows you to create, edit, share and collaborate on documents through a web browser. If you have an Office 365 account, you can also write and edit online in Word.

LibreOffice is an instance of free and open-source software. Google Docs is free for personal use, but not open-source.

Document design using a word-processor

The most important single aspect of the design of your document is body text, in other words the paragraphs and other blocks of text, like quotations and bibliographies, that make up a written piece. The key consideration to bear in mind is to ensure that your content is clear and legible throughout. Among the most important factors are line length and spacing.

For an item like an essay, line length should be about eighty characters in total, including spaces: this makes it easier for the eye to move from line to line. For this reason, you should ensure that your document has generous left and right margins (up to 4 cm).

In Word, you can adjust these settings by choosing File > Page Setup > Margins…

Spacing and indentation

Spacing and indentation

You can adjust line spacing in Word by choosing Format > Paragraph. As line length increases, so should the spacing between lines. Line spacing is the measurement between the baseline of one line of text and the next. The gap between the descenders (in characters like p or q) on one line and the ascenders (in characters like d or l) on the next is traditionally referred to as leading (to rhyme with “heading”). If your font size is 11 pt, then this setting should be at least 13.5 pt. For a font size of 12 pt, your spacing should be 14.5 pt.

In written work like essays, the best way of marking a new paragraph is to apply a small indentation to its first line. Here again, you can ensure that your word-processor applies this style automatically. Choose Format > Paragraph, and set left indentation at the same measurement as your font size, e.g. 11 pt (Word will automatically convert this dimension into your selected default unit of measurement, e.g. to centimetres). You should also set spacing before and after each paragraph to 0 pt. By default, most word-processors add extra line spacing at the end of a paragraph. If you choose to follow this alternative style, you should set this additional space to the same dimension as your font size, e.g. 11 pt, or the equivalent of a blank line. But do not combine paragraph indentation with blank lines between paragraphs.

Inline elements

Considerations of style apply also to parts of your writing that arise within sentences and paragraphs. These are referred to as inline elements and include brief quotations, for instance, which are identified through the use of quotation marks. Another instance is the title of full-length works to which you may refer, e.g. Vita nuova, Faust, Cré na Cille, Les Années, Don Quijote.

Using styles

The best method of ensuring that these and other design preferences are applied consistently to your whole document is to use styles. These are formatting options that are built into each word-processing application. To access styles in Word, select Format > Style.

Modifying styles in Microsoft Word

Modifying styles in Microsoft Word

The style that applies generally to body text is Normal, which you can modify in line with your design decisions. Separate styles exist for each of the components of your essay, e.g. block quotations, for which the default style in Word is Block Text (note that you are likely to have modify this style substantially, as by default it presents quotations in italics, which is not an appropriate choice in your essays.)

Once you have formatted the required styles as necessary, you can apply them in the course of writing your essay by selecting Format > Style, and choosing Apply once you have identified the relevant style.

Why use styles?

One of the major advantages of using styles is that any changes you make to an individual format, e.g. block quotations or footnotes, are automatically applied to all instances in your text. You can also apply the same styles in more than one essay: once you have make the necessary modifications, they are available for re-use in each new document.

Styles in LibreOffice

LibreOffice is, like Word, extensively documented — search, for instance, for styles. Styles can be edited and applied in LibreOffice writer in much the same way. Select Styles > Manage Styles to identify an individual element and to apply your modifications to it.

Styles in LibreOffice

Styles in LibreOffice

For instance, you can opt to have numbered headings throughout your essay if this choice is appropriate to your content.

Styles in Google Docs

Styles can readily be applied also in Google Docs. Once you have logged on to your Google account, you can retrieve your documents and edit them from within a web browser. A file appears on screen in document format.

Styles in Google Docs

Styles in Google Docs

You can apply a format to a given element of your document using the editing tools displayed on screen, and then apply that in turn to a given style for use in future documents.

It is also possible to apply more specialized templates by incorporating Add-ons into your Google Docs profile. Here, for example, a dedicated MLA formatter has been added to a Google account for use with a given document.

Apply MLA style with an add-on

Apply MLA style with an add-on

Google Docs also allows you to modify your default fonts just as you can when using a word-processor application.

Selecting a font in Google Docs

Selecting a font in Google Docs

If you select More fonts, you are given the option of using additional fonts from within Google Fonts.

Options in Google Fonts

Options in Google Fonts

Note that you can specify which script you wish to use in selecting a given font style (here, the choice has been restricted to serif fonts).

4 - Creating and using PDFs

A PDF can be used in print and on screen

A file in in Portable Document Format is a printable document that presents contents, images and other elements consistently from device to device. This means that such a file appears identically irrespective of the machine on which it is opened. This format is now also used to create archives of digital documents.

Generating PDFs

Any word-processing application can be used to create a PDF. In Word, select File > Print, or press CMD+P (Windows) or CMD+P (macOS). Then, in the PDF tab in the bottom left-hand corner, select Save as PDF.

Save as PDF in Word

Save as PDF in Word

You can save the file under an appropriate name (preferably not essay.pdf so as to ensure the work in question can be clearly identified at a later date). Note that you can incorporate metadata into the PDF file by completing the boxes in the lower part of the screen.

If you opt to create a PDF in Google Docs, by selecting File > Print, you can opt to create a PDF following the same procedure as in Word.

To create a PDF in LibreOffice, select File, Export as PDF > Export as PDF….

Save as PDF in LibreOffice

Save as PDF in LibreOffice

Several options can be applied before exporting and saving the file as a PDF.

Advantages and disadvantages

Portable Document Format is a very widely used computer application and because it is an archival format it is likely that material in a PDF will be accessible for the long term.

There are a number of advantages to using a PDF as the file format in which to save a file

  • a PDF can generate high-resolution print output
  • a PDF is also an online format and can be viewed within a web browser
  • content and presentation in a PDF are fixed, which means that it will appear identically in each machine in which it is opened (in other words, a PDF is “device-independent”)
  • because your chosen fonts are embedded in a PDF, the printed output will be consistent from printer to printer
  • a PDF can be used to create a file with information which you may want to circulate in a secure format and where you wish to retain the original formatting, for example, in a curriculum vitae
  • a PDF can be used as a presentation format: create and save your file in landscape format and open the file in full screen
  • it is possible to customize a PDF when creating so as to control its appearance on screen when opened
  • a PDF can be annotated, which makes it a useful research tool
  • PDF files can be combined to create a portfolio

There are one or two disadvantages to using PDF as a format

  • a PDF file can as a rule not be modified; if you wish to change the content, the routine option is to edit the original word-processor or other file, and then resave it as a PDF
  • PDFs require dedicated software, though such applications are now very widely available

Hybrid PDFs in LibreOffice

LibreOffice provides the option when exporting to PDF format of embedding the original word-processed file. This means that an original word-processed file can be directly associated with the PDF you generate from it.

LibreOffice: embed ODF file in PDF

LibreOffice: embed ODF file in PDF

If you check the relevant box and save the PDF in this way, you then have the option of dragging and dropping the resulting PDF into LibreOffice in order to access the original Open Document Format file, allowing you to edit the original content — an approach that could be useful if, for example, you are collaborating on a file with another person.

5 - Templates

How to use templates in word-processing applications

All word-processing applications allow you to make use of templates in order to maintain a consistent style from document to document. Here are some examples to get you started.

Additional fonts

First, install the following fonts on your machine using these links to download the relevant compressed .zip files:

The Noto CJK fonts allow you to combine Latin script with characters in Japanese, Korean, Simplified Chinese or Traditional Chinese.

Once you have unzipped the downloaded files, you can then install the fonts.

Using the templates

Next, you can download these two templates, all of them designed for use with LibreOffice:

You can also obtain an MLA template for Word directly from Microsoft.

Accessing CJK character sets

Note that you will have to choose which precise Noto CJK font you wish to use according to the language in which you will be writing — here, Simplified Chinese is selected.

Selecting a CJK font in LibreOffice

Selecting a CJK font in LibreOffice

6 - Revision history

How to track versions of your work over time

In both Word and Google Docs, it is possible to review and re-edit earlier versions of your work. This is possible in both cases because your files are saved in the cloud (provided that any document that is opened and edited in the version of the Word application on your computer is also saved in OneDrive).

One document, many uses

Version history in Google Docs

Version history in Google Docs

This facility allows you to retrace your steps when you need to do so, for instance when you delete or amend a piece of writing which you then wish to recover. It also means that you can use different versions of a single file for different purposes, for instance a curriculum vitae: in Google Docs, you can assign a specific name to a given version of your work.

Version history as backup

These forms of version history also function as a rudimentary backup for your work. Because all of the versions are saved in the cloud, you should be able to recover your files in the event of a hard disk failure on your computer.

Version history in Word

Version history in Word

To access version history in Word, choose File, and then Browse Version History.

7 - File formats

A file’s format is expressed in its file extension

Files store information in particular formats, according to their function and often also the application (or applications) with which they are associated. So, you can open an image file with an application like Preview on macOS, or Adobe Photoshop.

Word-processor files

A file format is typically designated by the file’s extension, which takes the following format: .xxx. In other words, the extension contains metadata, or information about the file, typically its file type and the data it contains. A Word file is a text document produced using a word-processor and has the extension .docx.

This is also an Open XML format, which means a Word file can more easily be transferred between computers and also transformed into other document formats. It also makes it compact and modular in its structure. Because information about the file is stored together with its contents, it will open with the same appearance in a different user’s computer.

A LibreOffice file with the extension .odf is also a word-processing file. LibreOffice makes use of the OpenDocument Format. This format supports structured documents that are interoperable. This means that ODF files can be read on machines using different operating systems and with a range of different applications other than LibreOffice.

Both Word and LibreOffice store all of the information associated with a given document in the form of a compressed archive file (usually a .zip file).

Contents of a LibreOffice template file archive

Contents of a LibreOffice template file archive in .odt format

As well as the contents of the file, this format contains information about the styles used in a given document as well as its metadata. All of this data is in the form of .xml files, a format designed for the exchange of information between computer applications. The eighteen files of which this example is made up also include an image file in .jpg format embedded in the document — it is the largest file by some margin. Finally, because these files also contain information about the configuration of the LibreOffice application in which the document was created, it too will be retrieved with exactly the same layout when opened in a different machine.

Word and LibreOffice files can also be used with Google Docs.

Plain text formats

Several file formats exist in which textual information can be encoded more simply than in a word-processing files. These are referred to as “plain text” formats because they contain only text. The simplest of these formats is a .txt file, whose contents include none of the formatting found in word-processor files.

In Windows, you can open a .txt file using the Notepad application and in macOS with TextEdit. Both of these are plain text editors. You can also download and install other such editors, like Atom or Visual Studio Code.

Plain text files are used in the creation of corpora and you can download copies of works of literature in this format from Project Gutenberg to create a corpus of your own, or with web applications like Voyant Tools.

Binary document formats

From these examples we can conclude that the contents of a document can exist within files of different formats and that it is possible to transfer the content between formats, so that the document can then be edited using different applications. Google Docs can be used to import and can export files in a range of formats.

It is also possible to generate a file in a binary format from a word-processing document. The most common outcome of such an operation is a Portable Document Format file with the extension .pdf. Files in Word or a LibreOffice or Google Docs can be used to create a PDF.

Source  Adobe Document Cloud

 

A binary file is in a file format that contains digital data not in the form of plain printable characters. While it is now possible to transform a PDF file into a format in which it can be edited in Word, for instance, a word-processing application cannot be used to open the digital PDF file directly. Instead, you must use a dedicated application that will retain the exact appearance of the document contained in the file, like Adobe Acrobat Reader.

Because such applications exist for all operating systems and for mobile devices as well as computers, a PDF file is said to be “platform-independent”.

There are also dedicated open-source applications like AntFileConverter, which allow you to convert word-processor files or PDFs into plain text for use with corpus tools.

Image files

Most image files are also binary files containing digital data. Typical formats include .jpg, .png and .tiff files. In both .jpg and .png files, some of the binary data is compressed. On the other hand, both .png and .tiff files are “lossless”, which means that the original data can be fully reconstructed from a compressed file.

Font files

A digital typeface is typically made up of a series of font files that contain the information required to render different individual fonts, e.g. that typeface’s roman, italic and bold styles or weights. An OpenType font file contains the information needed to allow the font to be displayed using computers with different operating systems, e.g. Windows or macOS. OpenType fonts can also contain extended Unicode character sets and a range of typographic features, e.g. small capitals, non-lining numerals.

TrueType is a further scalable font format that can be accessed both in Windows and macOS. Web Open Font Format makes use of compressed font files for display in web applications.

Common file extensions and formats

.css
a file in Cascading Style Sheet language that controls the appearance of an HTML file on screen, in print and in other media
.docx
a Word text document
.epub
an e-book file for use with most e-book readers (note, however, that a Kindle uses files in .azw or .azw3 format); as well as text, it can support color images, graphics, interactive elements, and video files
.html
a document in Hypertext Markup Language designed for display on the web
.jpg
a compressed lossy image format
.key
a macOS presentation file
.md
a Markdown document; a plain text format
.mov
a QuickTime video file
.mp3
a lossy audio format
.mp4
a video file format
.odf
a LibreOffice text document
.otf
an OpenType font file
.pages
a macOS text document
.pdf
a printable document in Portable Document Format that presents contents, images and other elements consistently from device to device
.png
a lightweight lossless image format
.pptx
a Microsoft Powerpoint file; also an Open XML Format
.rtf
a document data format used for saving and sharing text files
.tiff
a lossless image format
.ttf
a TrueType font file
.txt
a plain text document
.wav
a lossless audio format
.woff, .woff2
Web Open Font Format font files
.xml
a file in Extensible Markup Language used for storing and transporting information
.zip
an archive file format that supports lossless compression of files or directories