42
NZ Transport Agency research report style guide September 2016 NZ Transport Agency NZ Transport Agency research report [number] This title page is the first page of the report, ie page 1, right-hand page. It features: the full title of report in ‘Title’ style (20pt Lucida Sans, bold, sentence case (initial caps for proper nouns only), left aligned, 0pt before and 6pt after paragraph spacing, single line spacing) the author(s) initials + surname(s), their affiliation and location, in ‘Author’ style (12pt Lucida Sans, regular, left aligned, 0pt before and after paragraph spacing, exactly 16pt line spacing) at 8cm from top margin (TM) the series number of the report in ‘Title page RR number’ style (12pt Lucida Sans bold, sentence case, 0pt before and after paragraph spacing, exactly 16pt line spacing), at the bottom of the page. the name of the contracted research organisation in ‘Author’ style. The page set-up for margins throughout the report is mirror margins with TM 3.5cm, bottom margin (BM) 2.5cm, inside 2.5cm, outside 2cm. No page number is shown. See section 3.2 for more information.

NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

Embed Size (px)

Citation preview

Page 1: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

NZ Transport Agencyresearch report style guideSeptember 2016

NZ Transport Agency

NZ Transport Agency research report [number]Contracted research organisation – [Research organisation name]

This title page is the first page of the report, ie page 1, right-hand page.

It features:

the full title of report in ‘Title’ style (20pt Lucida Sans, bold, sentence case (initial caps for proper nouns only), left aligned, 0pt before and 6pt after paragraph spacing, single line spacing)

the author(s) initials + surname(s), their affiliation and location, in ‘Author’ style (12pt Lucida Sans, regular, left aligned, 0pt before and after paragraph spacing, exactly 16pt line spacing) at 8cm from top margin (TM)

the series number of the report in ‘Title page RR number’ style (12pt Lucida Sans bold, sentence case, 0pt before and after paragraph spacing, exactly 16pt line spacing), at the bottom of the page.

the name of the contracted research organisation in ‘Author’ style.

The page set-up for margins throughout the report is mirror margins with TM 3.5cm, bottom margin (BM) 2.5cm, inside 2.5cm, outside 2cm.

No page number is shown.

See section 3.2 for more information.

Page 2: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

ISBN 978-0-478-XXXXX-X (electronic)ISSN 1173-3764 (electronic)

NZ Transport AgencyPrivate Bag 6995, Wellington 6141, New ZealandTelephone 64 4 894 5400; facsimile 64 4 894 [email protected]

NZ Transport Agency (2016) NZ Transport Agency research report style guide. NZ Transport Agency research report [XXX]. 36pp.

[Research organisation] was contracted by the NZ Transport Agency in year to carry out this research.

This publication is copyright © NZ Transport Agency. This copyright work is licensed under the Creative Commons Attribution 4.0 International licence. You are free to copy,

distribute and adapt this work, as long as you attribute the work to the NZ Transport Agency and abide by the other licence terms. To view a copy of this licence, visit http://creativecommons.org/licenses/by/4.0/. While you are free to copy, distribute and adapt this work, we would appreciate you notifying us that you have done so. Notifications and enquiries about this work should be made to the Manager National Programmes, Investment Team, NZ Transport Agency, at [email protected].

Keywords: [in alphabetical order] documents, guide, house style, manual, New Zealand, NZ Transport Agency, publishing, reports, writing [see section 3.4 for more information]

This verso title page is page 2, ie left-hand page.

The text is placed at the bottom of the page. Page set-up and formatting are as follows:

The standard page set-up for margins is used (see section 2.1.2).

No page number is shown.

The standard body text style is used, ie ’Normal’ (9pt Lucida Sans, left aligned, 3pt before and 6pt after paragraph spacing, exactly 14pt line spacing).

This page lists:

1 ISBN (International standard book number)

2 ISSN (International standard serial number)

(These numbers are supplied by the NZ Transport Agency and the editor.)

3 NZ Transport Agency’s address details as given below

4 The research organisation contracted to carry out the research and the year the contract was signed

5 The report’s bibliographic reference

6 Information on copyright (which is held by the publisher, ie the NZ Transport Agency)

7 Keywords at the bottom of the page in alphabetical order (see section 3.3 for more information on keywords)

8 See section 3.2 for more information on the verso title page.

Page 3: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

An important note for the readerThe NZ Transport Agency is a Crown entity established under the Land Transport Management Act 2003. The objective of the Agency is to undertake its functions in a way that contributes to an efficient, effective and safe land transport system in the public interest. Each year, the NZ Transport Agency funds innovative and relevant research that contributes to this objective.

The views expressed in this research report are the outcomes of the independent research, and should not be regarded as being the opinion or responsibility of the NZ Transport Agency. The material contained in the report should not be construed in any way as policy adopted by the NZ Transport Agency or indeed any agency of the NZ Government. The report may, however, be used by NZ Government agencies as a reference in the development of policy.

While research reports are believed to be correct at the time of their preparation, the NZ Transport Agency and agents involved in their preparation and publication do not accept any liability for use of the research. People using the research, whether directly or indirectly, should apply and rely on their own skill and judgement. They should not rely on the contents of the research reports in isolation from other sources of advice and information. If necessary, they should seek appropriate legal or other expert advice.

Page set-up:

standard margins (see section 2.1.2)

‘Heading 1 no contents (18pt Lucida Sans bold, sentence case, 0pt before and 18pt after paragraph spacing, at least 16pt line spacing)

‘Normal’ body text (see section 2.1.4)

no page number shown

see section 3.4 for more information on the disclaimer.

Page 4: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

AcknowledgementsPlease include in your acknowledgements the Steering Group chair and members and the two peer reviewers by name, as well as anyone else who made a notable contribution to the research project.

In the body of the report:

• acknowledge the use of material from outside source(s), as this is a condition of its use as well as a courtesy (also make sure such material is in the relevant place(s) in the text, or is cited)

• ensure all publications cited in the text are listed in the references chapter in the endmatter

• acknowledge all personal communications (pers comm) where they are cited in the text (do it in a footnote if further details are needed) – but do not include these citations in the references chapter.

Also ensure copyright has not been breached.

Abbreviations and acronyms Include here a list of all abbreviations and acronyms used in the report:

• If it takes less than one page, place it here for easy access by the reader. The entries are arranged alphabetically.

• If it is longer than one page, create a glossary as an appendix (see section 7.1).

Page set-up for page 4:

standard margins (see section 2.1.2)

‘Heading 1 no contents (18pt Lucida Sans bold, sentence case, 0pt before and 18pt after paragraph spacing, at least 16pt line spacing)

‘Normal’ body text (see section 2.1.4)

no page number shown

see sections 3.5 and 3.6 for more information.

Page 5: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

ContentsExecutive summary..............................................................................................7Abstract..............................................................................................................81 Introduction................................................................................................9

1.1 NZ Transport Agency.............................................................................................91.2 Style guide.............................................................................................................91.3 The introduction.....................................................................................................9

2 Formatting the Transport Agency’s research reports..................................102.1 Formatting the A4 text.........................................................................................10

2.1.1 Paper size................................................................................................102.1.2 Margins....................................................................................................102.1.3 Page numbering......................................................................................102.1.4 Font type and size, and text spacing.......................................................102.1.5 Headings..................................................................................................102.1.6 Headers...................................................................................................112.1.7 Quotations...............................................................................................122.1.8 Unusual words.........................................................................................122.1.9 Equations and symbols............................................................................122.1.10 Footnotes.................................................................................................12

2.2 Word processing requirements............................................................................132.3 Requirements for editing.....................................................................................132.4 Requirements for the Transport Agency’s website..............................................13

3 Preliminary pages.....................................................................................143.1 Title page.............................................................................................................143.2 Verso title page....................................................................................................143.3 Keywords.............................................................................................................153.4 Disclaimer............................................................................................................153.5 Acknowledgements..............................................................................................153.6 Abbreviations and acronyms................................................................................163.7 Contents...............................................................................................................163.8 Executive summary and abstract........................................................................17

4 Main text..................................................................................................184.1 Headings..............................................................................................................184.2 Conclusion............................................................................................................18

5 Figures and tables.....................................................................................205.1 Numbering figures and tables..............................................................................205.2 Formatting figures and tables..............................................................................20

5.2.1 Format for tables.....................................................................................205.2.2 Format for figures....................................................................................21

5.3 Placing figures and tables in the report...............................................................215.4 Captions...............................................................................................................225.5 Hyperlinks............................................................................................................22

6 References................................................................................................23

Page 6: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

6.1 Style for references..............................................................................................236.2 Order in list..........................................................................................................246.3 Referencing a book..............................................................................................246.4 Referencing a part in a book................................................................................246.5 Referencing a journal paper.................................................................................246.6 Referencing a published report............................................................................246.7 Referencing unpublished material.......................................................................256.8 Referencing websites...........................................................................................256.9 Conference proceedings......................................................................................25

7 Endmatter.................................................................................................267.1 Glossary...............................................................................................................267.2 Appendices..........................................................................................................26

8 Language usage........................................................................................278.1 Abbreviations.......................................................................................................278.2 Hyphens...............................................................................................................288.3 Interrupting the flow............................................................................................288.4 Lists......................................................................................................................28

8.4.1 Bulleted lists............................................................................................298.4.2 Numbered lists........................................................................................29

8.5 Numbers, dates and time.....................................................................................308.5.1 Punctuation..............................................................................................308.5.2 Words v numbers.....................................................................................308.5.3 Columns of numbers................................................................................308.5.4 Very large numbers.................................................................................308.5.5 International currency.............................................................................30

8.6 Plain English.........................................................................................................318.7 Shall and will........................................................................................................328.8 Split infinitive.......................................................................................................328.9 Technical terms or jargon....................................................................................328.10 Tense...................................................................................................................328.11 That vs which.......................................................................................................33

9 Checklist...................................................................................................34Appendix A: Summary of styles used in the research reports...............................35

Page 7: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

Executive summaryBegin the executive summary on a new, odd-numbered (right-hand) page, after the contents list. Use Arabic numerals for the page number.

This is the summary that gets the message of the research report across to the readers. It is an overview and summation of the whole report, written by the author.

Ensure it:

• is simple and clear, and summarises the research, methods and results

• includes the conclusion, using more or less the same words that are used in the text to avoid confusion

• is no longer than three pages

• can be used separately from the report, eg it has no references, it explains acronyms and abbreviations if they are used and it has a header (on the second page) that shows the title of the report

• does not contain figures, although tables are acceptable

• contains the years over which the research was carried out, and the location if applicable.

Write the executive summary last, so you can link it with what is written in the main report.

Use the text headings as guides, and include key sentences from the main sections for consistency with the rest of the report.

Get someone who is not familiar with your research to read the executive summary and ask if they understand what your research is about.

Page set-up:

standard margins (see section 2.1.2)

header from edge 2cm, footer from edge 1.5cm

‘Heading 1 no number’

‘Normal’ body text (see section 2.1.4)

page numbers shown in Arabic numerals, eg 9 (odd numbered), starting on right-hand page

header with title of the report starts on the following page (even numbered) (see section 2.1.6).

Page 8: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

NZ Transport Agency research report style guide

AbstractPlace the abstract directly below the executive summary or on the following page.

The abstract:

• gives a summary of the project, with its aims and maybe brief results

• is not more than 200 words

• does not contain references, figures or tables

• explains any acronyms or abbreviations that may have to be used in the abstract, so it can stand alone

• contains the years and location in which the research was carried out

• is used in library and other catalogues (eg DYNIX), in abstracting journals (eg Chemical abstracts) and in bibliographies.

Page set-up:

standard margins (see section 2.1.2)

‘Heading 1 no number’

‘Normal’ body text (see section 2.1.4)

page number shown.

Page 9: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

1 Introduction

1 Introduction1.1 NZ Transport AgencyThe NZ Transport Agency is a Crown entity established under the Land Transport Management Act 2003. The Transport Agency’s objective is to undertake its functions in a way that contributes to an efficient, effective and safe land transport system in the public interest. Each year, the Transport Agency invests a portion of its funds in innovative and relevant research (including the publication of that research) in order to contribute to this objective. The Transport Agency considers the output of research to be an important addition to the knowledge base of the wider transport sector. However, in this context research is just that, research. It may be used in the development of standards and guidelines, or as a reference in the development of policy. It is not intended to be automatically adopted by the Transport Agency or any other agency of the NZ Government.

To assist in the research publication process, the Transport Agency has prepared this style guide as a tool to be used by researchers and editors. The style guide is designed to provide guidance to researchers on the structure and formatting of research reports – which are the main output of research projects. Given that research reports are published under the Research Programme banner on the Transport Agency website, consistency in layout and style is important.

1.2 Style guideA style guide is a written set of in-house conventions for dealing with aspects of report writing and production. This particular guide covers the preferred conventions to follow when producing research reports for publication by the Transport Agency. The conventions range from the order of sections within a report, its formatting, punctuation and guidelines for some English usage, to aspects of website preparation.

Not all the information given in this style guide has to be slavishly followed. For example, the spacings and dimensions for positioning text on the pages may need to be changed to suit the text and to obtain the most readable and pleasing visual impact. However, be consistent throughout your text if you need or want to make changes.

The layouts of some pages are best left for the editor to complete, especially the title page, verso title page, contents, etc because ISBNs and report numbers have to be added, and spacing may need to be adjusted (if the title is, say, long or short).

1.3 The introductionThe introduction is the first page of the main text, and it usually begins on an odd-numbered (right-hand) page (but may begin on a left-hand page to avoid a blank page if the abstract is on a right-hand page.

This section of the main text must include:

• the years the project was carried out and the country (eg New Zealand) or location to which the project relates

• the aims and objectives of the research, to show what the final report is about• any special references to other people's input and their work, including published and/or

unpublished material (use the correct titles of these people and companies).

9

Page 10: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

NZ Transport Agency research report style guide

2 Formatting the Transport Agency’s research reports

2.1 Formatting the A4 textThis section describes the format used for the Transport Agency’s research reports, ie the size and shape of the publication, as well as the general appearance, layout and typography of the text on the page.

2.1.1 Paper size• Use A4 paper.

2.1.2 Margins • Make sure that ‘mirror margins’ are on in the page set-up: ‘Inside’/’Outside’ margins will appear,

which allows a gutter for binding.

• Standard margins for all pages are mirror margins with TM 3.5cm, BM 2.5cm, inside 2.5cm, outside 2cm.

2.1.3 Page numbering• Numbers are centred at the bottom of page, in ‘Footer’ style (9pt Lucida Sans regular font, 3pt

before, 6pt after and single spacing).

• The pages are counted from the first (title) page, but numbers do not appear on the title page, its verso, the disclaimer or the acknowledgements page. The pages are numbered from the contents page onwards in Arabic numerals.

• Right-hand pages take odd numbers and left-hand pages take even numbers.

• Page numbers for appendices and other endmatter continue sequentially from the main text.

2.1.4 Font type and size, and text spacing • The body of the text is in 9pt Lucida Sans regular type (‘Normal’ style in this document).

• Line spacing is ‘exactly 14pt’.

• Paragraph spacing is 3pt before and 6pt after.

• Text is left aligned.

2.1.5 Headings See section 4.1 for more information on using headings.

• See below for the hierarchy of font type and sizes used in headings.

• Use sentence case for the headings, ie capitalise only the first letter and any proper names.

10

Page 11: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

2 Formatting the Transport Agency’s research reports

Heading 1:

1 Lucida Sans 18pt, bold, sentence case (initial cap followed by lower case)

Start a new page, as these are new chapters. Allow 0pt before and 18pt after for paragraph spacing and at least 16pt for line spacing.

Heading 2:

1.1 Lucida Sans 16pt, regular, sentence caseAllow 12pt before and 12pt after paragraph spacing and at least 16pt line spacing.

Heading 3:

1.1.1 Lucida Sans 12pt, regular, sentence caseAllow 9pt before and 9pt after paragraph spacing and at least 14pt line spacing.

Heading 4: 1.1.1.1 Lucida Sans 9pt, bold, sentence case

Allow 6pt before and 6pt after paragraph spacing and single line spacing.

If you need to use five levels of headings, copy Heading 4 but use italics instead of bold and do not number this heading level.

2.1.6 Headers A header is brief descriptive matter, usually the title of the chapter and/or the title of the report, set in the top or head margin of a page. It may also be called a ‘running head’.

Headers are especially useful to readers if the report is large or it has several parts. They are required but you may wish to leave inserting them to the editor.

Format headers as follows, using the ‘Header’ style:

• Left-hand (even-numbered) page carries the title of the report in sentence case and 8pt Lucida Sans with 3pt before and 6pt after paragraph spacing and at least 12pt line spacing.

• Right-hand (odd-numbered) page carries the title of the chapter or part in sentence case and 8pt Lucida Sans with spacing the same as for the left-hand header.

• A border is placed below the header text.

• Tab spacing is 1.5cm, same as that used for chapter and section headings.

11

Page 12: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

NZ Transport Agency research report style guide

2.1.7 QuotationsInline quotations are distinguished by single quotation marks.

Quotations within inline quotations are distinguished by double quotation marks.

Use ‘Quoted text’ formatting for block quotations (9pt Lucida Sans italic, 3pt before and 6pt after paragraph spacing, with exactly 14pt line spacing). The whole quotation is indented by 1cm on the left/inside and right/outside margins, and is not distinguished by quotation marks. An example follows.

The NZ Transport Agency has a vision to create transport solutions for a thriving New Zealand.

The text of a direct quote is not changed in any way from the original text, ie include original errors, tense and spelling (eg do not change American spelling to New Zealand spelling).

2.1.8 Unusual words New terms, unusual words or words with meanings specific to your text may be put in single quotes the first time they are used. Explain them in footnotes, in parentheses in the sentence or in a glossary at the end of your report. An example could be ‘trip legs’.

2.1.9 Equations and symbolsIn-line equations and symbols are in italics, but may need to be distinguished from other letters in the sentence, eg by single quotation marks, commas or parentheses.

When placing equations on a separate line in a paragraph, they are centred, in 9pt or 8pt font (depending on appearance), italicised and have 6pt before and 6pt after paragraph spacing.

The equation number is in parentheses, Lucida Sans type, 8pt, regular and flush to the right margin. Include the chapter number. An example follows.

Log distress = 0.105 TMIN + 4.78 (Equation 2.1)

When writing equations in the main text, you may find that the Lucida Sans subscript disappears as it is placed quite low. In this case change the subscript to another font such as Lucida Sans Unicode or Arial.

2.1.10 FootnotesInclude a footnote (at the bottom of a page) when you consider it necessary or useful to provide the reader with additional information which is not an essential part of the main text. Use footnotes sparingly and keep them to less than 4cm of the page.

Use superscript numerals and place them in the text after any punctuation mark and outside closing brackets. If the footnote refers to a specific word, place the superscript numeral immediately after the word.

Use ‘Footnote Reference’ for the superscript numeral (6pt Lucida Sans, raised by 3pt), eg 1

For the text of the footnotes use ‘Footnote Text’ style (8pt Lucida Sans, spacing 2pt before and 2pt after with at least 12pt line spacing) and label the notes 1, 2, 3, etc.

12

Page 13: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

2 Formatting the Transport Agency’s research reports

2.2 Word processing requirements The draft final report must be submitted as an electronic MS Word copy, ready for editing by the Transport Agency’s contracted editors. The electronic copy must include all tables, graphs and maps in the main body of the report, and not as separate documents.

Submit your research reports in electronic form as an email attachment. The report can be submitted on a CD if the file size is too big to email. However, such big reports are discouraged as there are limits to the size that can be published online. The editor uses the electronic form to edit and produce the final copy for printing the report.

The research report is to be on PC-formatted files, in Word.

If you use the Mac platform, convert the file format before submitting the research report to the Transport Agency, and let the editor know that codes other than Word may be embedded.

2.3 Requirements for editingSubmit your final draft report in the Transport Agency house style set out in this guide, without your company logo.

Ensure that you have supplied all parts of the report listed in the checklist (see chapter 9).

After you have submitted your final draft report to the Transport Agency, it will be reviewed prior to being sent to the editor.

2.4 Requirements for the Transport Agency’s websiteWhen the research report has reached publication stage, the Transport Agency may arrange for the report to be published on its website.

13

Page 14: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

NZ Transport Agency research report style guide

3 Preliminary pages

3.1 Title page The title page is the first page of the report, ie page 1, right-hand page. Its page number is not shown.

Use the standard page set-up for margins, as in section 2.1.2 (ie mirror margins with TM 3.5cm, BM 2.5cm, inside 2.5cm, outside 2cm).

The title page bears:

• the title in ‘Title’ style (20pt Lucida Sans bold, sentence case (initial caps for the first word and proper nouns only), left aligned, 0pt before and 6pt after paragraph spacing, single line spacing)

• the author(s) initials and surname(s) (or author’s preference), their affiliation and location, in ‘Author’ style (12pt Lucida Sans regular, title case, left aligned, 0pt before and 0pt after paragraph spacing, exactly 16pt line spacing), at about 8cm from TM

• the series number of the report in ‘Title page RR number’ style (12pt Lucida Sans bold, sentence case, left aligned, 0pt before and 0pt after paragraph spacing, exactly 14pt line spacing), at the bottom of the page

• the name of the contracted organisation follows below the series number in ‘Author’ style as in the second bullet point above.

The title is the important message that makes people read your report, so:

• keep it short and to the point

• check that it says what the project really is about

• write it in sentence form first, as a simple statement about the project

• include the country (ie New Zealand) if it is relevant

• pare off excess words, verbs and prepositions, without losing the meaning.

3.2 Verso title page The verso title page is page 2, ie a left-hand page:

• Don’t show the page number.

• Place the text at the bottom of the page.

• Use the standard page set-up for margins (see section 2.1.2).

• Use ‘Normal’ style (9pt Lucida Sans regular, left aligned, 3pt before and 6pt after paragraph spacing, exactly 14pt line spacing).

This page is usually compiled by the editor and lists the following:

1 ISBN (International standard book number)

2 ISSN (International standard serial number)

(The Transport Agency and the editor supply these numbers, which are codes used to identify books and the series of a publication. Each Transport Agency research report is a book because

14

Page 15: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

3 Preliminary pages

each is about a different topic and so has its own ISBN number. However, as the reports also constitute a series published by the Transport Agency, the series has an ISSN number which is given in each report.)

3 Publisher (which in this case is the Transport Agency) and its address

4 Bibliographic reference of the report (which is used when citing the report elsewhere)

5 The name of the organisation contracted to carry out the research and the year the contract was signed

6 copyright information. Copyright is held by the publisher (ie the Transport Agency)

7 Keywords (see section 3.3) in alphabetical order at the bottom of the page.

3.3 KeywordsPlace a list of keywords at the bottom of page 2, the verso title page, in alphabetical order.

Keywords are single words, or at most two words if the phrase is inseparable. Choose keywords carefully to ensure they:

• enable potential readers, through computer searches of library catalogues, bibliographies etc to retrieve the report by subject

• cover the topics in the report, so that it can be retrieved by users who do not know the full reference or its title or authorship.

Select keywords by both:

• broad topics that cover the overall content of the report, eg bitumen, environment, roads

• specific topics to narrow the options, eg chipseal, rural.

3.4 Disclaimer The disclaimer must be displayed in all Transport Agency research reports. It is placed on page 3 of the report.

The disclaimer page has:

• standard margins (see section 2.1.2)

• ‘Heading 1 no number’ (18pt Lucida Sans bold, sentence case, left aligned, 0pt before and 18pt after paragraph spacing and at least 16pt line spacing)

• ‘Normal’ body text (see section 2.1.4)

• no page number.

If the Transport Agency’s standard disclaimer (on page 3 of this guide) is not suitable for a particular publication, refer to the Transport Agency’s Coordinator National Programmes at [email protected] for advice before making changes.

3.5 Acknowledgements Include acknowledgements in the preliminary pages on page 4.

15

Page 16: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

NZ Transport Agency research report style guide

Please include in your acknowledgements the Steering Group chair and members and the two peer reviewers by name, as well as anyone else who made a notable contribution to the research project.

This page has:

• standard margins (see section 2.1.2)

• ‘Heading 1 no contents’ (see above)

• ‘Normal’ body text (see section 2.1.4)

• no page number.

In the text:

• ensure you acknowledge the use of material from outside source(s), as this is a condition of its use, as well as a courtesy

• ensure all publications cited in the text are listed in the references section in the endmatter

• acknowledge all personal communications (pers comm) where they are cited in the text (do it in a footnote if further details are needed). It is not necessary to include personal communications in the references section.

Also ensure copyright has not been breached.

3.6 Abbreviations and acronyms Include a list of all abbreviations and acronyms used in the report.

• If it takes less than one page, place it on page 4 below the acknowledgements, or on page 6 if there is space at the end of the contents list.

• If it is longer than one page, consider making a glossary (see section 7.1).

Check that:

• the entries are arranged alphabetically

• where an abbreviation or acronym occurs in the text for the first time, both the words and the abbreviation or acronym are shown, using parentheses, eg Ministry of Transport (MoT), Pascals (Pa)

• there is no space between a numeral and the abbreviation for the unit, eg 10g, 25km/h

• no full stops are used, except when ‘number’ is abbreviated to ‘no.’ to distinguish from the word ‘no’. However, in the plural use, ‘nos’ without a full stop.

3.7 ContentsThe contents list is compiled automatically from the text headings:

• Place it on a right-hand page, usually page 5.

• It has three levels (the third level is optional depending on the length of the contents list):

– Level 1 (TOC1) font is 9pt Lucida Sans (or 8pt if it allows a better fit), bold, left aligned, 3pt before and 3pt after paragraph spacing, at least 12pt line spacing.

16

Page 17: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

3 Preliminary pages

– Level 2 (TOC2) font is 9pt Lucida Sans regular, left aligned, 0pt before and 3pt after paragraph spacing, at least 12pt line spacing and indented 1cm.

– Level 3 (TOC3) font is 9pt Lucida Sans regular, left aligned, 0pt before and 3pt after paragraph spacing, at least 12pt line spacing and indented 2cm.

Note that the contents page has:

• no header

• page number in Arabic numerals

• standard margins (see section 2.1.2)

• the heading in ‘Heading 1 no contents’.

Note also that the contents pages do not include lists of tables or figures.

If page 6 (left-hand page) is not required for the contents, or other preliminary matter such as abbreviations or acronyms, it remains blank but numbered.

Before submitting the report to the Transport Agency:

• compile a fresh contents list to ensure it agrees with the headings and page numbers in the final text

• check visually that it agrees with the text as well

• use the list to check the number order of pages and levels of headings and to ensure the sequence of headings is logical.

See the contents list of this style guide (pages 5 and 6) for an example.

3.8 Executive summary and abstractSee pages 7 and 8 for information on how to structure and format the executive summary and the abstract.

17

Page 18: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

NZ Transport Agency research report style guide

4 Main textThis is the key part to the report, so ensure that it has:

• a structure and a logical pattern

• sections that follow a sequence, such as Literature review, Method, Results, Discussion, Conclusion and others as required

• headings to each section that:

– are numbered using the number ranking system, ie ‘outline numbered’

– follow the intention of the original project brief.

4.1 HeadingsWrite about the topics in the headings and keep the topics distinct. Especially avoid running the methods section into the results section.

To help control the sequence of subjects in the text, put the subject of a sentence at the beginning of that sentence. Likewise, the subject of a paragraph should be placed at the beginning of that paragraph.

Number the sections, but not the paragraphs, using the numbered ranking system to rank the headings of the sections to four or more levels. The following list gives an example of the format used to rank the headings (see section 2.1.5 for formatting details).

Check that the sequence of headings is logical and shows the development of the research. Check if any headings are out of place, or if they are missing or unnecessary. At the early stage of report writing, it may be helpful to use more numbered headings to identify the topics of the paragraphs and to check that the argument is developing logically. These extra headings can be omitted later.

4.2 Conclusions The conclusions are an important part of the report as they address the purpose and objectives of the research, as agreed in the project brief which is part of the contract for the research. However, research is just that – research. It is the role of the Government and its Agencies to consider and decide actions to be taken as a result of research, Therefore, the conclusions must:

• be written simply and effectively

18

1 Captif test parameters

1.1 Testing schedule1.1.1 Construction testing1.1.1.1 Subgrade testing

Page 19: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

4 Main text

• state clearly whether the research achieved the purpose and each of the objectives outlined in the project brief

• state if the research did not achieve the purpose and objectives, and why

• concur with the executive summary

• not include any new material – the conclusion must only refer to issues addressed in earlier chapters

• not include directives, recommendations or opinions.

19

Page 20: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

NZ Transport Agency research report style guide

5 Figures and tablesUse figures and tables to add to the readability/understanding of the report, but be sparing with your use of colour images and graphs and ensure they are indispensable to the report.

5.1 Numbering figures and tablesFigures and tables are numbered to include:

• the number of the chapter, eg 1

• a sequential number, starting from .1 for each chapter, eg figure 1.1, figure 1.2 and table 1.1 in chapter 1, and figure 2.1 and table 2.1 in chapter 2.

This system allows the reader to quickly identify the chapter in which they will find the figure or table referred to in the text.

This numbering system applies to figures, tables and equations.

Figures and tables are used to present information concisely and with maximum impact, and so:

• develop them while writing the text to ensure they are relevant

• ensure the facts they contain agree with the text and vice versa, and the facts are accurate

• keep them simple and clear

• if they are many, repetitive and/or disruptive to the text, consider putting them together in an appendix

• make sure figure and table captions are explanatory and link with the text (section 5.4 shows the caption format)

• when referring to figures or captions in the text, use lower case ‘f’ and ‘t’, eg ‘as shown in table 5.1’.

• place captions outside the figure, as part of the text and not embedded in the graphics, so they can be changed easily.

5.2 Formatting figures and tables 5.2.1 Format for tables You should:

• use landscape or portrait format, whichever is suitable

• use ‘Table text’ style (8pt Lucida Sans, 2pt before and 2pt after paragraph spacing with at least 12pt line spacing) for tabulated data

• use ‘Table text’ style bolded and 15 percent shading for column heads, with 0 percent shading for text (do not use black shading)

• use single line borders and gridlines

• for table footnotes, use ‘Footnote text’ style (8pt Lucida Sans, spacing 2pt before and 2pt after with at least 12pt line spacing) and label the notes (a), (b), (c) to distinguish them from page footnotes (which are labelled 1, 2, 3, etc).

20

Page 21: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

5 Figures and tables

For simple tables that are basically columns of figures, left align the text in the left column and centre the text in all other columns.

When tables include sentences (and paragraphs), left align the text in these columns.

Examples of tables:Table 5.1 Number of vehicles travelling between Waiouru and Turangi in the winter months of June, July, August of 1997

Vehicle type June July August TotalTruck 25 24 26 75Bus 9 8 12 29Car 50 40 0 180Total 84 72 128 284

Table 5.2 Catchment size calculation for Glenside station

Variable Coefficient Value Comment

AMSERVCB 0.137 0 Assumes no express services from Glenside to Wellington CBD (sensible as last station before Wellington CBD)

AMSERVTO 0.108 5 Assumes same as Takapu Road (next station up the line)

BESTTIME –0.070 12 Assumes 12 minutes (speed of 60km/h as consistent with Takapu Road)

DIST 0.057 12 Approximately 12km to CBD

PROXSH –0.167 1 Station location 500m from SH1

LIGHTING 0.807 1 Assumes site is fully lit

5.2.2 Format for figuresFigures include line drawings, graphs and photographs.

Any images (including photographs and diagrams) embedded in the text must be low resolution, ie a maximum of 200–300KB. This will help keep the document to a size that can be emailed during the editing process and will also ensure that the web pdf can be easily downloaded.

Where possible, use Lucida Sans font for diagrams, tables, equations etc to give a consistent style to the report.

5.3 Placing figures and tables in the reportLeft align both tables and figures on the page (see table examples above).

When inserting figures, ensure the text-wrapping feature is set to ‘Top and Bottom’. To do this, right click on the image, select ‘Wrap Text’ and then select ‘Top and Bottom’.

21

Page 22: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

NZ Transport Agency research report style guide

5.4 Captions Number figures and tables as explained in section 5.1. Use the following for layout:

• ‘Caption’ style (text 8pt Lucida Sans bold, sentence case, 3pt before and 6pt after paragraph spacing, at least 12pt line spacing, tab 2cm)

• captions are placed above tables and figures

• appendix tables and figures have prefix ‘A’ ‘B’ etc to indicate they are in an appendix, and not part of the main report (so that table A.1 is not confused with table 1.1).

Ensure any hyperlinking of captions to the text is removed prior to submitting your report (see section 5.5 below).

5.5 HyperlinksThe only hyperlinks permitted in the reports are for the Contents page(s), for chapter and section headings and for page numbering.

Important: If you have used hyperlinking of table and figure headers to the text, or in the compilation of the reference list during the preparation of the report, please ensure these links are removed before the report is submitted to the Transport Agency. Often these links are not applied consistently and have corrupted by the time the report reaches the editor.

22

Page 23: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

6 References

6 ReferencesThe Transport Agency research reports follow the Harvard referencing system which has brief in-text citations and a full alphabetical by author reference list or bibliography placed at the end of the report before the appendices.

A reference list contains all the references cited in the text. If the list includes publications that were not specifically cited in the research report but could be useful to other researchers, the title of this chapter should be Bibliography.

Compile the list of references as you insert the references in the text, and ensure that all are included. Copy spellings and other details exactly from the original article, especially authors’ names, dates, titles and journal names, irrespective of any subsequent changes to them or to the original spellings, because that was the way the original was published.

6.1 Style for references The rest of this chapter gives an outline to help you prepare reference lists.

Note: you might sometimes need to discuss a government strategy in a research report. Use initial capital letters when you refer to a strategy in the text of the report, eg ‘…Safer Journeys is the government's strategy to guide improvements in road safety over the period 2010–2020’. When you refer to the strategy as a publication (usually, only in the references chapter, the title is italicised and in sentence case, eg ‘Ministry of Transport (2010) Safer journeys: New Zealand’s road safety strategy 2010–2020’.

The style for a reference list is:

• normal body text (‘Reference’ style in this document)

• first line is flush left, 0.5cm indent for the remaining lines to highlight alphabetical order.

To cite references in the text, the style is (author(s) [no comma] date), eg:

• one author: ‘... were developed by Chang (2008a) for the Transport Agency based on driver comprehension testing (Chang 2008b).

• two authors: ‘... of a variety of road features (Woolley and McLean 2006)’

• three or more authors: ‘Schiff et al (2013) note that …’ (remember, however, to list ALL the authors of the ‘et al’ in your full list of references)

• unpublished reports and personal communications: (J Bloggs, pers comm) – don’t use titles such as Mr, Ms, Dr, and give the year and date if known

• if no specific author is given, use the name of the department, company, etc responsible for the publication: eg ‘... (NZ Transport Agency 2016)’.

23

Page 24: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

NZ Transport Agency research report style guide

6.2 Order in listThe order of references in the list of references is as follows:

• alphabetical order, according to author

• if more than one author, in alphabetical order of the first, then of the second and, if necessary, of the third authors

• if more than one entry per author, in chronological order for that author

• if more than one entry per author for the same year, identify as 2003a, 2003b.

6.3 Referencing a bookAuthor(s) (date) Title of book in italics, edition (ed). Editor (Ed). Place of publication: Publisher and/or

printer. Total number of pages if known (as it gives a librarian an idea of the size of the book to look for).

Note: italics are used for a book title because the title is used to identify it in a library catalogue.

Example: Huang, YH (2004) Pavement analysis and design, 2nd ed. Englewood Cliffs NJ: Prentice Hall. 792pp.

6.4 Referencing a part in a bookAuthor(s) (date) Title of chapter or section. Page numbers in Title of book in italics, edition (ed). Editor

(Ed). Place of publication: Publisher and/or printer. Total number of pages if known.

Note: italics are used for the book title because the title is used to identify it in a library catalogue.

Example: Rosenthal, S and W Strange (2004) Evidence on the nature and sources of agglomeration economies. Pp2119–2171 in Handbook of regional and urban economics (vol 4). VJ Henderson and JF Thisse (Eds). Amsterdam: North-Holland.

6.5 Referencing a journal paperAuthor(s) (date) Title of paper. Title of journal in italics Volume, number (no.): page numbers.

Note: italics are used for the serial title of a journal paper because the serial name is used to identify it in a library catalogue.

Example: Bloggs, J (2008) How to kill time on a word processor. Journal of Waste Time Management 5, no.2: 10–11.

6.6 Referencing a published reportAuthor(s) (date) Title of report. Title of report series in italics report no. Total number of pages.

Note: italics are used for the serial title if the report is one of a series because the serial title is used to identify it in a library catalogue.

24

Page 25: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

6 References

Example: McGimpsey, P, J Havemann and J Sutcliffe (2009) Promoting sustainability in New Zealand’s rail system. NZ Transport Agency research report 370. 102pp.

6.7 Referencing unpublished material Author(s) or institution (date if available) Title of work. Title of report series or file, number of the work

if applicable or available, or title of institution responsible for the work. Total number of pages.

Note: italics are not used for either title or series because the work is neither a book nor one of a recognised or consecutive series.

Newspaper articles and documents on files are often difficult to cite. If in doubt, include more rather than less in your reference and refer to your librarian or the Transport Agency editors for advice.

Example: Reay, J (1981) Roads in forested hill land. Ministry of Lands and Forests, New Zealand. 20pp.

6.8 Referencing websitesAuthor(s) or institution (date if available) Title of work. Accessed xx/month/year. Website address

Note: website address is not underlined and is in black colour. Remove the hyperlink from the URL as this can conceal an underscore in the print version of the report (see also section 5.5 on hyperlinks).

Example: NZ Transport Agency (2011) NZTA research, issue 14, December 2011. Accessed 15 March 2012. www.nzta.govt.nz/resources/nzta-research/docs/nzta-14.pdf

6.9 Conference proceedingsExamples:

Fu, K, R Nune and JX Tao (2015) Social media data analysis for traffic incident detection and management. Transportation Research Board Annual Meeting 2015 paper #15-4022, Washington DC.

Goodman, S, Y Hassan and AO Abd El Halim (2004) The road to cost effective urban pavement friction measurement. SURF 2004 5th Symposium on Pavement Surface Characteristics on CD. Toronto, Canada.

Millar, G, R Tudge and C Wilson (2004) Microsimulation evaluation of the benefits of SCATS coordinated traffic control signals. In Proceedings Transportation Research Board Meeting, Washington DC, January 2004.

25

Page 26: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

NZ Transport Agency research report style guide

7 Endmatter7.1 Glossary A glossary lists technical or unfamiliar words, terms, equations, abbreviations, acronyms, etc with explanations. It can incorporate abbreviations and acronyms, in which case a list of abbreviations and acronyms is not required in the preliminary pages (see also section 3.7).

A glossary:

• is placed at the end of the report as the final appendix

• should not stint the information given in the explanations.

7.2 AppendicesAn appendix provides supplementary material that contributes to the report but is not essential for inclusion in the main text. It should be referred to in the main text. If it cannot be referred to, it may be irrelevant, so consider if it is needed at all.

If the appendices are written by the author:

• they are formatted in the Transport Agency style• the page numbers run on sequentially from the text.If the appendices are reprints of another report, or comprise a dataset or other material that cannot be changed:

• leave them in their original styles, even though these may be different from the main text and from each other

• obtain the best hard copy of the original text (especially if it comes from other sources) so that it can be reproduced successfully in the printing process

• supply electronic copies for inclusion in the website pdf• ask your editor for ideas, as special pagination may have to be devised. However, in general, appendices should:

• be numbered in alphabetical sequence, ie Appendix A, Appendix B, Appendix C, so that references to them are distinct from the numbering system used for the chapters, figures and tables of the main text

• have numbered pages if possible, but each case may have to be considered differently• include a list of references cited in the appendix.

26

Page 27: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

8 Language usage

8 Language usageSome basic information about the use of the English language when writing Transport Agency reports is given here.

8.1 AbbreviationsFull stops are not used after abbreviations unless one is needed to avoid confusion – for example ‘no.’ for ‘number’ – but ‘nos’ in the plural.

Spell out the full name of an organisation, body or term the first time you use it in a document. If it has a common abbreviated form, place this in brackets after the name and use this abbreviation in the rest of the chapter or document.

Examples:

a warrant of fitness (WoF)

key performance indicator (KPI)

Do not use ‘NZ’ for New Zealand in general text or headings, unless it is part of the name of an organisation, eg NZ Transport Agency.

Please note the abbreviation of ‘the NZ Transport Agency’ is ‘the Transport Agency’. Do not use the abbreviation ‘NZTA’.

For other countries, if a name appears frequently in the text and is easily recognised, it may be abbreviated.

Example:

The tests were carried out in the UK, Canada and the US.

The following common abbreviations are not italicised. The Latin words from which the abbreviations are derived are in parentheses and italics here.

am before noon (ante meridiem)

pm after noon (post meridiem)

pers comm personal communication

eg for example (exempli gratia)

et al and others (et alia/alii)

etc and so forth (et cetera)

km/h kilometres per hour

ibid in the same work (ibidem)

ie that is (id est)

NB take careful note (nota bene)

vs against (versus)

See also section 8.5 Numbers, for more information on using abbreviations.

27

Page 28: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

NZ Transport Agency research report style guide

8.2 HyphensThe following gives some basic assistance with the use of hyphens. If you’re not sure whether a word needs a hyphen or not, check it in a dictionary. If you can’t find the word, decide what you think is best and use that approach consistently throughout your report.

Compound adjectives should be hyphenated when they are used before a noun.

Examples:

It is a well-known bookLand-use policy

but

The book is well knownThe policy on land use

Note: if one unit of the compound adjective is an adverb ending in ly a hyphen is not used.

Example:

A frequently used vehicle

The Transport Agency’s style is not to use a hyphen with ‘coordinate’ or ‘cooperate’.

8.3 Interrupting the flowThe punctuation appropriate for interrupting the flow of a sentence depends on the kind of break required.

• Comma (,) provides a soft interruption.

• Dash (– en rule) is the most interruptive and is used to introduce new material. Watch the balance of the whole sentence, as it indicates an abrupt change of thought. It is common in informal writing.

• Parentheses ( ) are used for an aside and to add other parts of a sentence. Watch the balance of the whole sentence. Consider if the information really needs to be shown in this way: could it be a footnote? or should it be omitted? or should it remain as part of the sentence? (Do not use a comma before parentheses; if a comma is needed, it goes after the parentheses.)

• Brackets [ ] mean an interpolation, such as another’s comment, or a supplied omission.

• Brace { } relates a group of lines to a smaller number of lines in another column.

• Colon (:) introduces a new part, which may be an explanation of preceding statements or a list or a series of coordinated statements. Do not use a second colon to denote a list within a list.

• Semi-colon (;) separates statements that are too closely related to be written as separate sentences; it may separate expressions in series or in lists where commas are not enough to separate the components.

8.4 Lists When compiling lists:

• keep the same structure (eg either phrases or clauses) throughout a list

28

Page 29: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

8 Language usage

• use bullets, as they are distinctive and do not imply sequences

• use numbers or letters if the list is sequential or they make understanding easier for the reader.

8.4.1 Bulleted listsUse the ‘Bullet’ style (ie ‘exactly 14pt’ line spacing and 3pt before and 6pt after paragraph spacing, aligned against the left margin, with 0.63cm between the bullet and the text)

For a list of words or short phrases (ie without verbs):

• begin each line with a lower case letter

• don’t use punctuation at the end of each bullet point, except for a full stop after the final one.

Example:

• cost

• efficiency

• availability.

For a list of complete clauses (ie with verbs):

• start each sentence with a capital letter

• finish each sentence with a full stop.

Example:

• A sentence starts with a capital letter.

• A sentence ends with a full stop.

Lists with items at a second level use:

• bullets at first level

• en dashes at the second level.

Example:

• Analyse the options.

• Make recommendations based on:

– cost

– efficiency.

8.4.2 Numbered listsUse the Bullet number style (ie ‘exactly 14pt’ line spacing and 3pt before and 6pt after paragraph spacing, aligned against the left margin, with 0.63cm between the number and the text).

Example:

The two areas surveyed were:

1 traffic calming devices

8 road markings.

29

Page 30: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

NZ Transport Agency research report style guide

Use this numbering hierarchy:

1

a

i

Note: there is no punctuation after the final number in each item.

8.5 Numbers8.5.1 Punctuation• Use commas between large numbers that have blocks of 0s, eg 234,000 and 10,000.

• No comma is used in numbers with four digits or less, eg 2460.

• There is no space between a number and the unit, eg 50km/h.

• Financial amounts are always written as digits, eg $65,000 and Y10,000.

8.5.2 Words v numbers• Spell out numbers below 10. Write all other numbers as numbers.

• In tables, use numbers whatever their size.

• Do not start a sentence with a digit but spell out the number (and its unit, if relevant) or re-arrange the sentence.

8.5.3 Columns of numbers• Use the units as column headings, then list the numbers, eg

$/tonne25,00018,00043,00086,000

8.5.4 Very large numbers• If a number has more than five zeros, use the unit, eg million. Write the unit either in full

(eg 63 million) or as an abbreviation (eg 63M).

• Use numbers if the number has five zeros or fewer, eg 500,000 and 10,000.

8.5.5 International currency• Write the abbreviations and numbers (without spaces) in this order: NZ$500, A$10, US$600,

CAN$400.

30

Page 31: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

8 Language usage

8.6 Plain EnglishWrite in plain language that is simple and direct and conveys your meaning as precisely as possible. Choose your words carefully and only use words that are necessary for what you want to say.

Don’t use Use instead

ascertain find out

at the end of the day, in the final analysis

finally, ultimately

at this point in time now, currently

despite the fact that despite

endeavour try

has the capability of can

in as much as since, because

in close proximity to near, close

in order to to

in relation to, in respect of about, concerning, on

in the event of this happening if this happens

it is often the case that often

large numbers of many

on a regular basis regularly

owing to the fact that because

prior to before

request ask

subsequent to after

with regard to about

utilise use

Avoid over-using the following convenience words:

commence due to following

however majority practically

prior to remainder there is

therefore virtually

31

Page 32: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

NZ Transport Agency research report style guide

8.7 Shall and will‘Shall’ is used when giving orders or making firm declarations.

‘Must’ implies an unavoidable obligation.

‘Will’ may be used when making a simple prediction.

‘May’ may be confused with ‘shall’, but generally it implies that you are not necessarily required to do that thing.

8.8 Split infinitive The following definition of and comment on the split infinitive is taken from the Oxford writers’ dictionary (OUP 1996): The separation of ‘to’ from its verb by other words. Objected to by many, but the cure is often worse than the disease.

To illustrate: To boldly go where no-one has gone before – in which the adverb ‘boldly’ splits the verb ‘go’ from ‘to’, and therefore forms a split infinitive. Although grammatically incorrect, this first sentence construction is more effective than the following ‘correct’ version: To go boldly where no-one has gone before.

Examples to show the effect of using ‘only’ and the ‘split infinitive’:

We only are going – in this sentence the verb is not split, and the position of ‘only’ emphasises that we and no-one else are going.

We are only going – in which the verb is split by ‘only’ and the sentence has acquired a different meaning, ie our going is the only thing we are doing.

8.9 Technical terms or jargonDefine terms (or jargon) that are used frequently in the research report and may not be familiar to all the readers, especially if they have alternative meanings or are used differently in the context of a particular report. Ensure the definition is given where the term is first used in the text.

For consistency and for the reader’s use, consider listing all the definitions, preferred spellings, symbols and acronyms of terms. The list can be placed either on one of the preliminary pages or as a glossary.

8.10 Tense The following guidelines will help you decide the appropriate tense to use in a report.

• Use tenses consistently and keep to present, or past, or past and conditional tense.

• Do not mix tenses.

• When reporting the findings of another research document or your own work, use past or conditional tense, ie reported speech, as the work has been done.

• When commenting on the work of another researcher, use the present tense. This avoids confusion over whose opinion it is, and it is what you think now.

32

Page 33: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

8 Language usage

• Do not use the passive voice if you can avoid it.

8.11 That vs whichUse ‘that’ in a clause that identifies the person or thing (ie a defining relative clause), eg ‘Apply the rule that I am proposing’. The sentence loses much of its meaning if the clause ‘that I am proposing’ is left out. No commas are needed.

Use ‘which’ in a clause that does not define a person or thing (ie a non-defining relative clause), eg ’The rule, which I agree with, will be proposed’. Commas are used to set off the clause, and the sentence does not lose its meaning if it is left out.

33

Page 34: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

NZ Transport Agency research report style guide

9 ChecklistConsult the checklist below to ensure that all the tasks have been attended to before sending in your report. You also need to:

• check that all references cited are listed, and vice versa

• complete the title page, verso title page (with the information that is available to you), disclaimer, acknowledgements and contents

• check the spelling and titles of names of companies, people, places, etc

• check spelling and grammar by reading, preferably aloud, and back up (but not rely on) with computer aids such as spell check.

Title page, with author’s name and affiliation

Verso title page (completed by editor)

Keywords

Disclaimer

Abbreviations, acronyms, acknowledgements

Contents

Executive summary

Abstract

Introduction

Conclusions

References and/or bibliography

Tables, appendices

34

Page 35: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

Appendix A: Summary of styles used in the research reports

Appendix A: Summary of styles used in the research reportsWe have provided below a list of styles mentioned in this style guide that are to be used in the research reports.

Style Details

Author 12pt Lucida Sans, regular, line spacing exactly 16pt, 0pt before and 0pt after, left aligned

Bullet 9pt Lucida Sans, regular, line spacing exactly 14pt, 3pt above and 6pt after, left aligned, tab 0.63cm, hanging 0.63cm

Caption 8pt Lucida Sans, bold, sentence case, line spacing at least 12pt, 3pt before and 6pt after, tab 2 cm, left aligned

Equation 8pt or 9pt Lucida Sans, italic, line spacing at least 12pt, 3pt before and 6pt after, centred

Equation number 8pt Lucida Sans, regular, line spacing at least 12pt, 3pt before and 6pt after, right aligned

Footer 9pt Lucida Sans, regular, line spacing at least 12pt, 3pt before and 6pt after, centred

Footnote reference 6pt Lucida Sans, regular, raised by 3pt

Footnote text 8pt Lucida Sans, regular, line spacing at least 12pt, 2pt before and 2pt after, left aligned

Header 8pt Lucida Sans, regular, sentence case, line spacing at least 12pt, 3pt before and 6pt after, left aligned, tab 1.5cm

Heading 1, Heading 1 no contents Heading 1 no number (for appendices)

18pt Lucida Sans, bold, sentence case, line spacing at least 16pt, 0pt before and 18pt after, left aligned, tab 1.5cm

Heading 2 16pt Lucida Sans, regular, sentence case, line spacing at least 16pt, 12pt before and 12pt after, left aligned, tab 1.5cm

Heading 3 12pt Lucida Sans, regular, sentence case, line spacing exactly 14pt, 9pt before and 9pt after, left aligned, tab 1.5cm

Heading 4 9pt Lucida Sans, bold, sentence case, single line spacing, 6pt before and 6pt after, left aligned, tab 1.5cm

Normal (body text) 9pt Lucida Sans, regular, line spacing exactly 14pt, 3pt before and 6pt after, left aligned

Quoted text (for 9pt Lucida Sans, italic, line spacing exactly 14pt, 3pt before and 6pt after, left

35

Page 36: NZ Transport Agency research report style guide - issued ... Web viewNZ Transport Agency research report style guide. 5. ... NZ Transport Agency research report style guide. ... use

NZ Transport Agency research report style guide

indented block quotations)

aligned, indented 1cm on inside and outside margins

Reference 9pt Lucida Sans, regular, sentence case, line spacing exactly 14pt, 3pt before and 6pt after, hanging 0.5cm

Table text 8pt Lucida Sans, regular, sentence case, line spacing at least 12pt, 2pt before and 2pt after, left aligned

Table text centred 8pt Lucida Sans, regular, sentence case, line spacing at least 12pt, 2pt before and 2pt after, centred

Table heading 8pt Lucida Sans, bold, sentence case, line spacing at least 12pt, 2pt before and 2pt after, left aligned

Table heading 8pt Lucida Sans, bold, sentence case, line spacing at least 12pt, 2pt before and 2pt after, centred

Title 20pt Lucida Sans, bold, sentence case, single line spacing, 0pt below and 6pt after, left aligned

TOC 1 9pt Lucida Sans, bold, line spacing at least 12pt, 3pt before and 3pt after, left aligned

TOC 2 9pt Lucida Sans, regular, line spacing at least 12pt, 0pt before and 3pt after, left aligned, indented 1cm

TOC 3 9pt Lucida Sans, regular, line spacing at least 12pt, 0pt before and 3pt after, left aligned, indented 2cm

36