Technical Report Guidelines

1. CONTENT OF TECHNICAL REPORTS

In the following sections, brief information about the content of a technical report is given.

1.1. Acknowledgements

The candidate may desire to include a page with a brief note of an

acknowledgement of help received from particular people. All

organizations proving financial support must also be acknowledged,

with project identifications like grant number, etc.

1.2. Abstract

The abstract should give the information that will enable a scholar to tell

whether he/she wishes to read the complete work. Therefore, the

abstract should cover the following points: Statement of the problem,

procedure or method, results, conclusions. Two abstracts, one in English

and the other in Turkish, should be included. The abstract should

contain no headings, tabular material, chemical formulas, or footnotes.

Abstracts should not contain references, but author citing is allowed.

The abstract page should contain the title of the report. The Turkish

abstract (“Özet”) must follow the English abstract in the same format.

1.3. Table of Contents, List of Figures, Tables and

Symbols/Abbreviations

Theses are expected to have a “Table of Contents” for the convenience

of the reader. If figures and tables are scattered throughout the text, a

separate “List of Figures” (and/or “List of Tables”) must be included

1

after the Table of Contents. These lists should include page numbers.

Similarly, a “List of Symbols” (or “List of Symbols/Abbreviations”, as

appropriate) should be included. “List of Symbols/Abbreviations” can

contain abbreviations listed alphabetically as a separate group following

the symbols.

1.4. Text

The text of the report will follow at this point. The first chapter (in most

cases, Introduction) will start on the first page of the text, i.e. the first

page enumerated in Arabic numerals.

When writing your report, pay attention to some of the precautions

listed below:

• The whole text should be left and right justified.

• Periods, commas, semicolons and colons go outside the quotation

marks.

• The word “data” is plural and requires a plural verb.

• Integers from one to nine, inclusive, should be spelled out except

when they represent a chapter or a section; for number 10 and above,

use numerals. Numbers should be spelled out when they begin a

sentence.

• Spell out per cent; do not use %, and write per cent as two words

without a period within the text.

1.5. Appendices

2

The last section may contain supporting data for the text in the form of

one or more appendices. Examples of appendix material include data

sheets, questionnaire samples, flowcharts, illustrations, maps, software

listings, charts, etc. If the appended data should include oversize

illustrations or maps, several alternative methods of inclusions are

available.

3

2. FORMATTING TECHNICAL REPORTS

In the following sections, basic rules in formatting technical reports are given.

2.1. Character Fonts

As a character font, use Times New Roman. The font size must be 12 point in the text

including formulas, equations, table headings and figure captions.

At least 8 point should be used in figures, tables and super or subscripts. Footnotes, long

biographical quotes and extensive quotations should be 10 points.

2.2. Spacing

Spacing of the text material shall be 1.5 or when necessary integer multiples thereof. For

example, when a paragraph ends, the next one starts after pressing RETURN twice (2×CR)

to get two 1.5 spacings. The followings are exceptions:

• Footnotes — single spacing

• Long biographical quotes — single spacing

• Extensive quotations — single spacing and indented one (1) centimeter relative to the

text material.

2.3. Margins

Margins of pages shall conform to the following specifications:

• Left margin — 3.5 cm from edge of paper

• Right margin — 2 cm from edge of paper

• Top margin — 3.5 cm from edge of paper

4

• Bottom margin — 2 cm from edge of paper

The above margins shall be observed on charts, graphs, tables, and

drawings. Folded papers will not be accepted unless there is absolutely

no other way for the material to be presented.

2.4. Pagination

Each page (except the title page) is expected to bear a number. Only

one side of the paper may be used.

The preliminary section, including the title page; copyright page, if any;

foreword, preface, or acknowledgements; table of contents, etc., should

be numbered, using lower case Roman Numerals, e.g., i, ii, iii, etc. The

title page counts as Page i, but the number does not appear. The

sequence of the preliminary section is as follows:

Title Page Page i — number does not

appear

Foreword, Preface or Acknowledgements Page ii as

necessary

Table of contents Page iii, iv..

List of Symbols/Abbreviations Page v, vi as necessary

List of Tables Page vii, viii as necessary

List of Figures Page ix, x as necessary

Abstract Page xi, xii as necessary

Özet Page xiii, xiv as necessary

For the remainder of the report, Arabic numbers are used. Each page

must be numbered. Page numbers are to be placed two centimeters

from the bottom and right hand margins on the pages and must be 12

5

point. Include all pages for illustrations, tables, appendices,

bibliography, etc.

2.5. Headings

2.5.1. Main Headings

Main headings numbered such as 1., 2., etc. must obey the following

rules:

• They must begin a new page and be centered. Omit period at the end

of the heading. Main headings must be typed in bold face and must be

in capital letters and in 14 points.

• Main headings should reflect content of the text that follows. Main

headings are not to be called as chapters.

• The number of the headings will be followed by a period and two

spaces.

• They must precede the following text material or second heading by

(3×CR).

2.5.2. Second Headings

Second headings numbered such or 2.1., 2.2., etc. must obey the

following rules:

• They must be aligned left and be typed in 12 points, bold face and,

capital and lower case letters; i.e., the first letter of each word except

6

conjunctions, prepositions and articles must be a capital letter. Omit

period at the end of heading.

• The number designation of the second heading will be followed with a

period and two spaces.

• Second headings must be (2×CR) below preceding text and (2×CR)

above of succeeding text, but need not begin a new page.

2.5.3. First Subheadings

First subheadings numbered such as 2.1.1., 2.1.2., etc. must obey the

following rules:

• They must be typed on separate lines beginning at the left margin line

of the text, but need not begin a new page.

• They must be typed in bold face and with capital and lower case

letters except conjunctions, prepositions and articles.

• The number designation of the heading will be followed by a period

and two spaces. Omit period at the end of the heading.

• First subheadings must be separated from the preceding and

succeeding text by (2×CR).

2.5.4. Second Subheadings

Second subheadings numbered such as 2.1.1.1., 2.1.1.2., etc. must

obey the following rules; however, second subheading, should be

avoided if possible.

7

• They must be typed on the same line as the text it introduces,

beginning at the left margin line of the text.

• They must be typed in capital and lower case letters except

conjunctions, prepositions and articles.

• They must be followed by a period at the end of the heading and must

be underlined.

2.6. Citing (indication of references in main text body)

2.6.1. Citing according to surname of author

References are cited with the surname of author and year. In the

references section, the references are listed alphabetically according to

the surname of the author.

Citing of a reference at the beginning of or within a sentence must be as

Boran (2003), whereas a citation at the end of a sentence must be as

(Boran, 2003). The full-stop is placed directly after the citation.

A reference with two authors must be cited as Yılmaz and Johnson

(2004) at the beginning of or within a sentence, or as (Yılmaz and

Johnson, 2004) at the end of a sentence.

A reference with more than two authors must be cited as Yılmaz et al.

(2004) at the beginning of or within a sentence, or as (Yılmaz et al,

2004) at the end of a sentence.

Different publications of an author published in the same year must be

cited as Feray (2005a), Feray (2005b).

8

While citing multiple publications of an author in one pair of brackets;

the most recent publication must be cited last. For example; Past

research (Gogel, 1990, 2006, in pres).

While citing a part of a publication; the number of the page the cited

material (chapter, table, figure, or equation) is on must be indicated.

While citing, the expression “page” must be abbreviated, but “chapter”

must not.

For example; (Centers for Disease Control and Prevention, 2005, p. 10),

(Shimamura, 1989, Chapter 3).

Citing multiple publications in one pair of brackets; (Berndt, 2002;

Harlow, 1983)

Citing personal communication in main text body; (V.–G. Nguyen,

personal communication, September 28, 1998), (J. Smith, personal

communication, August 15, 2009).

In the references section, reference tags must be listed according to the

surname of author.

For citing of secondary references (In case the reference cites another

reference), the secondary reference must be cited in brackets. In the

references section, the reference tag is organized according to the

secondary reference, the original reference must not be used as a tag.

For example; In his e-mails, Smith argued that asynchronous line

dancing would be the next Internet meme (as cited in Jones, 2010).

2.6.2. Citing according to order of appearance

9

References are cited by numbering and indicating the number in square

brackets ([]) in the main text body. The first reference cited in a report

is numbered [1] and the following references are numbered according

to the order of appearance.

In the main text body, references must be cited as specified below:

[1] Reference no. 1

[1-3] References from no.1 to 3 (thus, references 1,2 and 3)

[1,3] References no. 1 and 3

[1,3,8] References no.1, 3 and 8

[1,3-8] References no.1, and from no.3 to 8 (thus, references 1, 3,

4, 5, 6, 7 and 8)

Different volumes of a reference must be cited and numbered

individually.

2.7. Listing of references

All references cited in a report must be listed in the “References”

section.

References cited according to surname of author must be listed

alphabetically according to the surname of author. References cited

according to order of appearance must be numbered and listed in

numeric order, according to the order of appearance.

Publications of the same author published in different years must be

listed starting from the older to the more recent. Publications of the

same author published in the same year are listed alphabetically

according to their titles. In order to provide distinction, the year

10

specified for such references must be succeeded with a letter starting

from a.

One-author publications of an author must be listed before that author's

multi-author publications. The surname of the second author must be

taken into account for alphabetical listing for multi-author publications

of the same author. In case the surnames of second authors are the

same, the surnames of third authors are taken into account.

Publications of different authors with the same surname must be listed

according to the title of the publication.

In case the author of a publication is a corporation, the name of the

corporation is regarded as the author, and must be listed in references

according to this name.

In case an author or editor is not specified for a reference, the citing tag

must be defined according to its title. In references section, listing of

such references must be done according to the title. In case the title

begins with a number, the reading of that number is taken into account

for listing.

2.8. Footnotes

Footnotes could be used in theses to add content-expanding, content-

enhancing, or additional information.

Footnote numbers must be placed directly after a quotation. In case the

quotation is a paragraph, the footnote numbers must be placed directly

after the last word of the paragraph (as superscript). In case the

11

quotation is a concept or a noun, footnote numbers must be placed

directly after that concept or noun (as superscript).

Footnote numbers in the main text body must be indicated as

subscript1, as shown. A punctuation mark must not be placed after the

number.

Footnotes must be written with a font size 2 pt smaller than the main

text body font size.

1 space must be set between footnote line and footnote number, 1/2

space must be set between footnote number and the first line of the

footnote. Footnotes must be separated from the main text body with a

thin horizontal line.

2.9. Appendices

Appendices must be numbered using letters (i.e. Appendix A, Appendix

B, Appendix C, etc.). Subsections of appendices could be numbered as

Appendix A1, Appendix A2, Appendix B1, Appendix B2.

Before the appendices section, a cover page with the title APPENDICES

which lists the numbers and names of appendices must be inserted.

Every appendix section must start with its number and name, i.e.

Appendix A Name of appendix Tables and figures given in appendices

must be numbered with the number of the appendix they are in ( i.e.

Table A.1, Table A.2, Figure A.1, Figure A.2).

Equations given in appendices must be numbered with the number of

the appendix they are in (i.e. (A 1.1), (A 1.2)).

12

Related material larger than A4 paper-size (such as maps) must be

given in appendices, not in the main text body.

Sections such as indexes and dictionaries must be given in appendices.

Additional material on storage media (CD, DVD etc.) must be placed in

an envelope attached to the inner side of the back cover of the report.

The name of the author of report and the appendix number must be

specified on such additional material. Also, the number and name of

such material must be listed on the appendices cover page (Appendix

C Computer program codes CD).

3. TEMPLATES

13

ACKNOWLEDGEMENTS

I would like to express my sincere gratitude to Professor Tezer

Danısman for his invaluable guidance and help during the preparation of

this dissertation. I would like to mention his patience, giving me

inspiration and hope when I was stuck at dead-ends.

I have very much benefited from the discussions with my dear friends in

the Mechatronics Laboratory, among whom I would like to mention

especially Ali Öğrenci, Veli Kırkdokuz, Hale Çalışkan and Jale Üretir. I

thank them all.

14

ABSTRACT

Frame relay is a connection oriented packet switching technique and is

intended for the interconnection of geographically separated local area

networks. Frame relay communication has been proposed to improve

the performance of ISDN packet transmission, but later it has been

found out that it alone could be used as a cost effective communication

technique. The work done in this M.S. report is part of a joint effort to

develop a high speed network test bed that involves a frame relay

switch, frame relay terminals and frame relay routers in the Computer

Networks Research Laboratory. The frame relay line speed of the test

bed has been selected as 2048 Kbps. IBM compatible personal

computer’s (PC’s) with ISA bus have been selected as frame relay

terminals and routers, since they have low cost and it is relatively easier

to solve their interfacing problems. A Motorola VME bus based

15

multiprocessor computer system has been selected as the main

component of the frame relay switch. The development of the frame

relay ISA bus interface and the development of frame switch interface

are the subjects of this M.S. report. Both interfaces have many common

functions, subsystems and components. The frame relay PC ISA bus

interface has been fully designed, realized as a board and tested for

operation. The frame relay switch interface has been designed based on

the experiences accumulated while developing the frame relay PC ISA

bus interface.

(IF NECESSARY) CHAPTER 4

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor

invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et

accusam et justo duo dolores et ea rebum. Stet clita kasd gub rgren, no sea takimata sanctus

est Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod

tempor invidunt ut lab ore sit et dolore magna.

Practical Application of This Study

16



accusam et justo duo dolores et ea rebum. Stet clita kasd gub rgren, no sea takimata sanctus

est Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod

tempor invidunt ut lab ore sit et dolore magna.

Second Level Title: First Letters Capital



accusam et justo duo dolores et ea rebum. Stet clita kasd gub rgren, no sea

Third level title: Only first letter capital



accusam et justo duo dolores et ea rebum. Stet clita kasd gub rgren, no sea

Fourth level title: Only first letter capital

Stet clita kasd gub rgren, no sea takimata sanctus est Lorem ipsum dolor sit amet,

consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut lab ore sit et

dolore magna.

Fifth level title: No numbering after fourth level titles



dolore magna.

17

Figure 4.1 : Example figure.

This indicates that the ANN is accurate at base flow and flow height values lower then 3

m.

Table 4.1 : Example table.

Column A Column B Column C Column D

Row A Row A Row A Row A

Row B Row B Row B Row B

Row C Row C Row C Row C



dolore magna. Stet clita kasd gub rgren, no sea takimata sanctus est Lorem ipsum dolor sit

amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut lab ore sit

et dolore magna.



dolore magna.

18

EXAMPLE FIGURE

REFERENCES

Abrahart, R. J., and See, L. (1998). Neural Network vs. ARMA Modelling: Constructing Benchmark Case Studies of River Flow Prediction. In GeoComputation ’98. Proceedings of the Third International Conference on GeoComputation, University of Bristol, United Kingdom, 17–19 September (CD-ROM).

Abrahart, R. J., and See, L. (2000). Comparing neural network and autoregressive moving average techniques for the provision of continuous river flow forecasts in two contrasting catchments, Hydrolog. Process., 14, 2157–2172.

Acar, M. H. and Yılmaz, P. (1997). Effect of tetramethylthiuramdisulfide on the cationic poymerization of cylohexeneoxide, The 2nd International Conferences on

19

References are listed alphabetically according to surname of author.

1 line spacing is set in this section.

Please delete this note before printing.

Advanced Polymers via Macromolecular Engineering, Orlando, Florida, USA, April 19-23.

Box, G. E. P., and Jenkins, J. M. (1976). Time Series Analysis: Forecasting and Control. Holden-Day, San Francisco, CA.

Burger, J., Gochfeld, M., Jeitner, C., Burke, S., Stamm, T., Snigaroff, R., Weston, J. (2007). Mercury levels and potential risk from subsistence foods from the Aleutians. Science of The Total Environment, 384, 93-105 doi:10.1016/j.scitotenv.2007.05.004.

Burke, W.F. and Uğurtaş, G. (1974). Seismic interpretation of Thrace basin, TPAO internal report, Ankara, Turkey.

Burlando, P., Rosso, R., Cadavid, L. G., and Salas, J. D. (1993). Forecasting of Short-term Rainfall Using ARMA Models. J Hydrol. Vol. 144, no. 1-4, pp. 193-211.

Deci, E. L., & Ryan, R. M. (1991). An motivational approach to self: Integration in personality. In R. Dienstbier (Ed.), Nebraska Symposium on Motivation: Vol. 38. Perspectives on motivation (pp. 237-288). Lincoln: University of Nebraska Press.

IOC-UNESCO. (1981). International bathymetric chart of the Mediterranean, Scale 1:1,000,000, 10 sheets, Ministry of Defence, Leningrad.

LePichon, X. (1997). Personal communication.

McCaffrey, R. and Abers, G. (1988). SYN3: A program for inversion of teleseismic body wave forms on microcomputers, Air Force Geophysics Laboratory Technical Report, AFGL-TR-88-0099, Hanscomb Air Force Base, MA.

Moore, C. (1991). Mass Spectrometry. In Encyclopedia of chemical technology (4th ed.) (Vol. 15, pp. 1071-1094). New York, NY: Wiley.

Nelson, M.R. (1988). Constraints on the seismic velocity structure of the crust and upper mantle beneath the eastern Tien Shan, Central Asia, PhD Report, MIT, Cambridge, MA.

Roberts. S. and Jackson, J.A. (1991). Active normal faulting in central Greece: An overview, in The Geometry of Normal Faults, Spec. Publ. Geol. Soc. Lond., 56, p. 125-142, Eds. Roberts, A.M., Yielding, G. and Freeman, B., Blackwell Scientific Publications,Oxford.

Sisaky, A., Golab, F. and Myer, B. (1989). Rust resistant potatoes, United Kingdom Patent, No: 2394783 dated 23.1.1989.

20

Simpson, B. (Producer) (2004). The corporation [DVD]. Canada: Big Picture Media Corporation.

TS-40561 (1985). Çelik yapıların plastik teoriye göre hesap kuralları, Türk Standartları Enstitüsü, Ankara.

Wegener, D. T., Kerr, N. L., Fleming, M. A., & Petty, R. E. (2000). Flexible corrections of juror judgments: Implications for jury instructions. Psychology, Public Policy, & Law, 6, 629-654.

Wolchik, S. A., West, S. G., Sandler, I. N., Tein, J., Coatsworth, D., Lengua, L., et al. (2000). An experimental evaluation of theory-based mother and mother-child programs for children of divorce. Journal of Consulting and Clinical Psychology, 68, 843-856.

Zuckerman, M., & Kieffer, S. C. (in pres). Race differences in face-ism: Does facialprominence imply dominance? Journal of Personality and Social Psychology.

Harper, E. B. (2007). The role of terrestrial habitat in the population dynamics and conservation of pond-breeding amphibians (Doctoral dissertation). Retrieved from http://edt.missouri.edu/

Star trek planet classifications. (n.d.). In Wikipedia. Date retrieved: 07.06.2010, adress: http://en.wikipedia.org/wiki/Star_Trek_planet_classifications

Url-1 <http://www.mohid.com>, date retrieved 29.06.2006.

Url-2 <http://www.elet.polimi.it/ >, date retrieved 10.01.2007.

Vanden, G., Knapp, S., & Doe, J. (2001). Role of reference elements in the selection of resources by psychology undergraduates. Journal of Bibliographic Research, 5, 117-123. Date retrieved: 13.07.2010, adress: http://jbr.org/articles.html

21

No dates available.


http://jbr.org/articles.html

[1] Abrahart, R. J., and See, L. (1998). Neural Network vs. ARMA Modelling: Constructing Benchmark Case Studies of River Flow Prediction. In GeoComputation ’98. Proceedings of the Third International Conference on GeoComputation, University of Bristol, United Kingdom, 17–19 September (CD-ROM).

[2] IOC-UNESCO (1981). International bathymetric chart of the Mediterranean, Scale 1:1,000,000, 10 sheets, Ministry of Defence, Leningrad.

22

While listing references in numeric order, the order of appearance is taken into account.

1 line spacing must be set in this section.


References retrıeved via Internet should be listed at the end.

APPENDICES

APPENDIX A: Maps

23

References retrıeved via Internet should be listed at the end.

24

APPENDIX A

(a) (b)

(c) (d)

(e) (f)

Figure A.1 : Regional maps: (a)Rain. (b)Flow. (c)Evapotranspiration …

25While captioning multi figures, each figure must be numbered with letters and described in the caption (if each figure is cited individually in main text body). In case the general caption is sufficient, numbering with letters is not required in appendices.

E X A M P L E

Titles of appendices must be listed under the main title “APPENDICES”, but must not be indicated in Table of Contents.

26

Table A.1 : Example table in appendix.

Column A Column B Column C Column D

Row A Row A Row A Row A

Row B Row B Row B Row B

Row C Row C Row C Row C

27

ABBREVIATIONS

AIC : Akaike Information CriteriaANN : Artificial Neural NetworkApp : AppendixBP : BackpropagationCGI : Common Gateway InterfaceESS : Error sum-of-squaresGARCH : Generalized Autoregressive Conditional HeteroskedasticityGIS : Geographic Information SystemsHCA : Hierarchical Cluster AnalysisMbps : Megabits per secondSt : StationSWAT : Soil and Water Assessment ToolUMN : University of Minnesota

28

1 line spacing is set.

The abbreviation is bold, where as the meaning is not.

Top, bottom, and outside margins: 2.5 cm, inside margin: 4 cm


29

LIST OF TABLES

Page

Table 1.1 : Table with single row and centered columns............................................2Table 2.1 : Table captions must be ended with a full stop...........................................4Table 3.1 : Multi-line captions: all lines belonging to the same caption must be

aligned......................................................................................................11Table 4.1 : Example table..........................................................................................14Table 5.1 : Example table in chapter 5......................................................................16Table 6.1 : Example table in chapter 6......................................................................18Table A.1: Example table in appendix.......................................................................25

30

For List of Tables, 1 line spacing must be set.

Alignment in this table was set with paragraph settings. Page numbers were entered manually.


All lines of multi-line captions must be aligned!


LIST OF FIGURES

Page

Figure 1.1 : Model structures.......................................................................................4Figure 2.1 : Advanced structures.................................................................................6Figure 3.1 : Neuron cell, adapted from (Çetin, 2003).................................................9Figure 3.2 : For multi-line figure captions, it is important that all the lines of the

caption are aligned..................................................................................11Figure 3.3 : Figure captions must be ended with a full stop......................................12Figure 3.4 : Landscape-oriented, full-page figure.....................................................32Figure A.1 : Regional maps: (a)Rain. (b)Flow. (c)Evapotranspiration …................58

İZMİR UNIVERSITY

31

TITLE PAGE FOR SUMMER TRAINING REPORT


FACULTY OF ENGINEERING

DEPARTMENT OF INDUSTRIAL ENGINEERING

MANAGEMENT PRACTICE REPORT

[Name of the Company]

Submitted to:[Name of Summer Practice Coordinator]

Submitted by: [Name and ID number of the student]

[Submission Date]

İZMİR / TURKEY

32

Documents

Technical Report Guidelines