formatting 1. the preliminary pages a sample of the cover page and title page are shown in fig. 1...

26
Formatting 1

Upload: maximilian-robinson

Post on 26-Dec-2015

220 views

Category:

Documents


4 download

TRANSCRIPT

Page 1: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

1

Formatting

Page 2: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

2

The preliminary pages

A sample of the cover page and title page are shown in Fig. 1 and Fig. 2,

respectively, the contentof which should be arranged

symmetricallyto fill up the entire page.

Page 3: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

3

Figure 1:Sample of the cover page of a hardbound report with spine

TITLE OF PROJECT

BY

NAME OF STUDENT

MONTH and YEAR

spine

Tan Boon Heng B.Eng. (H

ons) Electrical Engineering 2014

Page 4: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

4Fig. 2 Sample of a title page

B.ENG (HONS)MECHANICAL DESIGN ENGINEERING

Final-Year Project 2014/15

Uni. logo SIT logo

PROJECT TITLE:PROJECT No:

NAME:UNI MATRICULATION No:

FIRST SUPERVISOR:

SECOND SUPERVISOR:

INDUSTRY SUPERVISOR (if any):

Page 5: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

5

The declaration form should be filled up after your work is completed ( Fig. 3)

or

you may have to write a paragraph about your declaration (see sample of written declaration).

Declaration

Page 6: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

6

Fig. 3 Sample 1 of a declaration page.

Page 7: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

7

Sample of a declaration page

DECLARATION

I hereby declare that I carried out the work reported in this report in the Department of Electrical Engineering, University of Ilorin, under the supervision of Mr. David Wang (give the name of your supervisor). I solemnly declare that to the best of my knowledge, no part of this report has been submitted here or elsewhere in a previous application for award of a degree. All sources of knowledge used have been duly acknowledged.

(Signature and Date)

.........................................NAME OF STUDENT

MATRICULATION NUMBER

Page 8: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

8

Arrangement of title pages,typography and page numbers

Apart from the title and declaration pages, text on all other preliminary pages and in the main body of the report should bedouble-line spaced and typed usually in Times New Roman 12-point font. Use lower case Roman numerals from the abstract

page to the symbols and abbreviations page.The preliminary pages are to be arranged and numbered in the

following order:Title page (no page number)

Declaration (no page number)Abstract (e.g. page i)

Acknowledgements (e.g. page no. ii)Table of contents (e.g. page no. iii)

List of figures (e.g. page no. iv)List of tables (e.g. page no. v)

List of symbols and abbreviations (e.g. page no. vii)

Page 9: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

9

Abstract

Your abstract is a summary of your report that others can use as an overview.

Abstracts allow readers to quickly decide whether it is within their range of interests to

read the longer article.

Online databases use abstracts to index larger works. The keywords and phrases in abstracts

allow for easy searching.

Page 10: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

10

Acknowledgements

Expression of appreciation by the author to the people who have

contributed in one way or another to the success of the study/project should come on this page.

Some level of flexibility in the use oflanguage is allowed here.

Page 11: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

11

Table of Contents

The page contents should be written with left

and right justification

Subsections of chapter sections should be indented from

the left margin in the table of contents.

Page 12: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

12

List of figures, tables, symbols and abbreviations

The list of figures and list of tables should both providecaptions and page numbers, while the list of symbols andabbreviations should only indicate the meaning and units

of the symbols where applicable.

Providing page numberswhere symbols and abbreviations appear in the body of the

report is not required.

Page 13: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

13

The main body of the report

Pages in the main body should be numbered sequentiallyusing Arabic numerals, starting from page 1 (the introduction).

The mainbody should be broken into chapters giving appropriate

titles to each chapter.

Chapter one is usually the introductionchapter, while chapter two is normally dedicated to theliterature review, although a more specific title may be

given.

For chapters three to four, or five, a title reflecting thecontents of the chapter should be given. Chapter five or six

concludes the report and also makes some recommendationsfor future work on the project.

Page 14: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

14

Chapters

Each chapter should be divided into titled sectionsnumbered in accordance with the chapter number.

For example, Chapter one is titled “Introduction,” and its sections will be 1.1 introduction or

background information,1.2 the significance and motivation of the

study/project,1.3 aim and objectives of the study, 1.4

methodology, 1.5report outline, and so on.

Page 15: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

15

Chapters

With the exception of chapterone and the concluding chapter, the other chapters shouldnormally start with an introduction section and end with

the summary/conclusion section.

The introduction sectiontells the reader what to expect from the chapter while the

summary section, usually written in the past tense, presentsa brief account of the achievements of the same chapter.

Page 16: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

16

Subsections of a section in a chapter should bear titlesand numbers in accordance with the section numbers.

For example, subsections of section 2.2 in chapter two would be numbered as follows:

2.2.1, 2.2.2, 2.2.3.

Chapters

Page 17: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

17

Illustrations

In engineering, diagrams or figures are often used inthe text to complement an explanation in order to

enhance understanding of the presentation.

Each diagram or illustration should bear a meaningful caption that is numbered sequentially

in accordance with the chapter number and not thesection or subsection number in which they appear.

.

Page 18: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

18

Illustrations

The figure caption should be located at thebottom of the figure as close as possible to where it is cited in the

text.

All figures should be referenced in the text and this should be done prior to the appearance of such figures.

As much as possible, students should avoid referringto a figure as “the above or below figure” without mentioning the

actualfigure number or name.

Fig. 6 illustrates how a figure and its caption are presentedin a report.

Page 19: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

19

Fig. 6: One-line schematic diagram of a 9-bus power system

Page 20: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

20

Illustrations

It is also important to note that freehand drawings and manual labelling of figures should be avoided.

A number of software packages have adequate toolsfor drawing and labelling illustrations.

For example, Microsoft Word is adequate for drawing block diagrams as well as schematic diagrams.

Page 21: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

21

Illustrations

SmartDraw is very good in drawing schematic diagrams and circuit symbols.

There is hardly any diagram that cannot be drawn with Microsoft Visio - circuit diagrams, flow charts, block diagrams,

organization charts, and a host of others.

These software packages are readily available in the market at reasonable prices.

Page 22: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

22

Equations

In a similar vein, Equation Editor or MathType in Microsoft Word are very good options for the typing of equations in text.

These packages will present equations as natural as possible to avoid unnecessary ambiguities in their interpretations.

Equations should be numbered sequentially according to the name of the chapter in which they appear for ease of reference.

Equation numbers should be enclosed in parentheses and made to align toward the right hand margin of the text.

For example, chapter three could have equationnumbers (3.1), (3.2), and (3.3), that are cited in the text as

“Differentiating eqn (3.2) results in eqn (3.3)…”.

Page 23: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

23

Equations

When equations are cited at the beginning of a sentence, “eqn” would be written in full starting with a capital letter.

For example, “Equation (4.11) implies that the system being described is marginally stable and hence…”.

Each equation should appear on its own line and should be indented from the left margin of the text.

The use of dotted lines in between the equation and its number is no longer fashionable.

The following examples illustrate how to present equations in a text:

Page 24: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

24

Tables

Where there is a need to tabulate data or present results in a tabular form, proper tables should be drawn.

Each table should have a meaningful caption and must be numbered according to the chapter number in which it appears and should appear

on top of the table to which it is referring.

Page 25: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

25

Tables

While most journals prefer hiding the vertical border lines in tables,

some choose to present tables without border lines at all, as illustrated in Table 1 (on previous slide)

This is not to say that having border lines in tables are no longer in practice.

Like figures, all tables must be cited in the text prior to the appearance of such tables, except on occasions where the available space on the page

is not sufficient for the illustration.

Page 26: Formatting 1. The preliminary pages A sample of the cover page and title page are shown in Fig. 1 and Fig. 2, respectively, the content of which should

26

THE END