Formatting Scientific Documents

Slides:



Advertisements
Similar presentations
Typography Typography exists to honor content. — Robert Bringhurst,
Advertisements

Scientific Writing: An Introduction Writing Guidelines for Students The Craft of Scientific Writing 3rd edition (Springer-Verlag,
Scientific Writing Anders Malthe-Sørenssen Department of Physics University of Oslo.
The Colour Group Presentation Guideline Set out here are some recommended points of colour, style, layout and so on to help make your presentation as clear.
MLA FORMATTING. What is MLA formatting and why do I need to use it? "MLA (Modern Language Association) style is most commonly used to write papers and.
Poster produced by Faculty & Curriculum Support (FACS), Georgetown University School of Medicine Abstract A ‘roll-up’ poster is a single large sheet displayed.
Format for Ease of Access Importance Design Principles Design Elements.
Document Design: Basics and Typography Technical Communication, DAHMEN.
Formatting Scientific Documents. In scientific writing, formats vary considerably to serve different situations Formal Reports Presentation Slides Journal.
by Office of Graduate Studies
In your layouts, use white space for association, emphasis, and hierarchy space for margins space for illustrations space for headings.
Page Design / Style Guide Importance Design Principles Design Elements.
PAGE DESIGN PAGE DESIGN Giving Your Work the Best Possible Appearance.
Document and Web design has five goals:
In the name of Allah. Scientific & Technical Presentation Leila Sharif Sharif University of Technology
Chapter 7. Designing Documents and Web Sites © 2013 by Bedford/St. Martin's1 Document and Web design has five goals: to make a good impression on readers.
By: Wilmer Arellano FIU Fall 2013 Wilmer Arellano.
Objective 3.01 Understand Business Documents. Essential Questions to think about Why is formatting applied to fonts, paragraphs, and pages? What documents.
CSICS 2013 Monterey, California Your university or company logo goes here on title page (only!) CSICS 2014 San Diego, California CSICS 2014 Presentation.
Professional Template for a 48x36 poster presentation
Font & Typeface Principles of Information Technology
Font & Typeface Principles of Information Technology
The Craft of Scientific Writing
In Concert: An Integrated Reading and Writing Approach by Kathleen T
Designing Documents, Slides, and Screens
WAMICON 2018 Presentation Guidelines Author Name Author Affiliation
計畫名稱:控制學門105年度成果發表會海報格式說明
CSICS 2017 Presentation Guidelines
Readability and Legibility
Template for a 32”x 40” poster (title goes here)
Graphic Communication
WAMICON 2017 Presentation Guidelines Author Name Author Affiliation
Treatments that effect typography
Presentation Title Presenter name, Associates and Collaborators Extreme Science and Engineering Discovery Environment Introduction   This editable template.
Template for a 24”x 36” poster (title goes here)
Template for a 36”x 24” poster (title goes here)
Names of Authors in Calibri, 44 Points, Bold
Font & Typeface Principles of Information Technology
1.01 Investigate typefaces and fonts.
Layout Terms Visual Hierarchy
Template for IBI poster 56 inches in width and 36 inches in height The title occupies no more than two lines First Author1, Second Author2, Third Author1,2.
Science Fair Projects.
Oral Presentation Guidelines
Poster -- three by four foot poster: horizontal format
Oral Presentation Guidelines
Additional slides to address common questions from audience
Scientific Writing: An Introduction 1 Writing Guidelines for Students
Formatting Scientific Documents
Scientific Writing: An Introduction Writing Guidelines for Students
POSTER OPTION B (Project title goes here)
Your poster title here – usually formatted in lower case (preferred) or ‘Title Case’ Author Number One, MD, PhD1; Author Number Two, MD2; Author Number.
Title Author(s) Full Affiliation Details & Id
Desktop Publishing Terminology
Module 6.
Your poster title here – usually formatted in lower case
Oral Presentation Guidelines for IEEE WPTC 2018 Conference
Template for IBI poster 36 inches in width and 48 inches in height The title occupies no more than three lines First Author1, Second Author2, Third Author1,2.
Template for IBI poster 48 inches in width and 36 inches in height The title occupies no more than two lines First Author1, Second Author2, Third Author1,2.
IMS2016 Presentation Guidelines
Oral Presentation Guidelines for IEEE WPTC 2018 Conference
Scientific Writing: An Introduction Writing Guidelines for Students
Scientific Writing: An Introduction Writing Guidelines for Students
Poster with Horizontal Layout: Title of Poster in Arial, Bold, Points
Scientific Writing: An Introduction Writing Guidelines for Students
Designing Pages and Documents
Names of Authors in Calibri, 36 Points, Boldface
WAMICON 2019 Presentation Guidelines Author Name Author Affiliation
Oral Presentation Guidelines
Research Title (Template for a 48”x36” poster)
Names of Authors in Arial, 44 Points, Bold
Presentation transcript:

Formatting Scientific Documents On these notes pages, the page and chapter numbers refer to The Craft of Scientific Writing, 3rd edition (Springer-Verlag, 1996). Also referred to is the “Writing Guidelines for Engineering and Science Students,” which can be found at the following address: http://www.me.vt.edu/writing/ At that page, you will find links to the “Writing Exercises for Engineers and Scientists” and to the “Handbook for Instructors.” If you would like a 60-day evaluation copy of The Craft of Scientific Writing, please go to the following web page: http://www.springer.de/textbooks/textbook_inspect.html This first slide is a title slide for an introductory lecture about formatting scientific documents. This presentation has several purposes. The first purpose is to make sure that students know what the term format means and not to confuse that term with the terms style or structure. The second purpose is to dispel the misconception that many students adopt that only one correct way exists to format a document. The third purpose is to teach students a few principles about typography and layout. Shown as an example is the first page of a journal article. Students should realize that the format for a set of instruction, a report, a presentation slide, or a poster would look much different. (Pages 6 and 7) Reference for example article: Radomsky, R., and Thole, K. A., 2000, “High Freestream Turbulence Effects in the Endwall Leading Edge Region,” Journal of Turbomachinery, vol. 122, pp. 699-708.

In scientific writing, formats vary considerably to serve different situations This background slide makes the point that many different formats in scientific writing exist, and these formats differ significantly to serve various situations. For instance, journal articles typically have multiple columns and smaller type to pack more information into fewer number of pages. Presentation slides typically use a sans serif typeface because in small text blocks, sans serif type is read more quickly than serif typefaces are. These differences confuse many engineers and scientists who often look for universal rules. Engineering and science students often ask me which format is correct. That question is the wrong question to ask. The better question is which format is expected for the particular occasion. See pages 6-7 in The Craft of Scientific Writing or pages 37-38 in The Craft of Editing. Citation for formal report: Sheldon, Karl, Analysis Methods to Control Performance Variability and Costs in Turbine Engine Manufacturing, master’s thesis, http://scholar.lib.vt.edu/theses/available/etd-05072001-160537/unrestricted/MS_Thesis_Sheldon.pdf (Blacksburg, VA: Virginia Tech, 4 May 2001). Citation for example article: Radomsky, R., and Thole, K. A., 2000, “High Freestream Turbulence Effects in the Endwall Leading Edge Region,” Journal of Turbomachinery, vol. 122, pp. 699-708. Citation for presentation slide: Schmidt, Cynthia M., “Ways to Reduce Sulfur Dioxide Emissions from Coal-Fired Utilities,” presentation (Austin, Texas: Department of Mechanical Engineering, 8 December 1989). Formal Reports Journal Articles Presentation Slides

Not all rules of format are constant Reports Sandia Laboratories Figure 1 Table 1 equation 1 Textbooks Prentice-Hall Fig. 1 Table 1 equation (1) Journals ASME fig. 1 table 1 Eq. 1 This background slide makes the point that many aspects of format, including small things such as the way figures, tables, and equations are named, differ from institution to institution. These differences confuse many engineers and scientists who are typically inclined to notice details. Engineering and science students often ask me which format is correct. That question is the wrong question to ask. The better question is which format is expected for the particular occasion. See pages 6-7 in The Craft of Scientific Writing or pages 37-38 in The Craft of Editing.

Format is the arrangement of type on the page typography Mapping slide for discussion of format. The presentation is broken into two parts: a discussion about typography, and a short discussion about layout. Information about the formats of scientific writing can be found in Chapter 16. Citation for example article: Radomsky, R., and Thole, K. A., 2000, “High Freestream Turbulence Effects in the Endwall Leading Edge Region,” Journal of Turbomachinery, vol. 122, pp. 699-708. layout

Each typestyle has its own personality and power Serif Sans Serif Arial abcdefghijklmnopqr stuwxyz1234567890 Arial Narrow Comic Sans Times New Roman abcdefghijklmnopqr stuvwxyz1234567890 Garamond Courier Information about selecting typefaces in scientific writing can be found on pages 222-226. I discuss this aspect early in courses because it is so practical and because it applies to every assignment that the students submit.

Avoid large blocks of capital letters TYPE IS TO READ Type is to read WORDS SET IN ALL CAPS USE MORE SPACE THAN TEXT SET IN LOWERCASE. Words set in all caps use more space than words set in lowercase. Information about avoiding all capitals in scientific writing can be found on pages 225-226. When showing this slide, I ask students to think about presentations they have seen in which the presenter has used slides with all capitals--how tiring those presentations often were because the audience had to read each letter on the presentation slides. Then, I mention to the students how much faster it is to read words set in lowercase because we can recognize the words by the ascenders and descenders, rather than having to read every letter. In showing tte bottom portion, I tell the students how much more space the sentence in all capitals takes up as opposed to the sentence just beneath it, which has the same words. This amount of space is particularly important on presentation slides and posters.

Morton-Thiokol’s presentation to NASA suffered because of all capital letters on the slides PRIMARY CONCERNS - FIELD JOINT - HIGHEST CONCERN • EROSION PENETRATION OF PRIMARY SEAL REQUIRES RELIABLE SECONDARY SEAL FOR PRESSURE INTEGRITY • IGNITION TRANSIENT - (0-600 MS) • (0-170 MS) HIGH PROBABILITY OF RELIABLE SECONDARY SEAL • (170-330 MS) REDUCED PROBABILITY OF RELIABLE SECONDARY SEAL • (330-600 MS) HIGH PROBABILITY OF NO SECONDARY SEAL CAPABILITY • STEADY STATE - (600 MS - 2 MINUTES) • IF EROSION PENETRATES PRIMARY O-RING SEAL - HIGH PROBABILITY OF NO SECONDARY SEAL CAPABILITY • BENCH TESTING SHOWED O-RING NOT CAPABLE OF MAINTAINING CONTACT WITH METAL PARTS GAP OPERATING TO MEOP • BENCH TESTING SHOWED CAPABILITY TO MAINTAIN O-RING CONTACT DURING INITIAL PHASE (0 - 170 MS) OF TRANSIENT Given on this slide is a poor example of typography from Morton-Thiokol’s presentation to NASA to try to delay the launch of the Space Shuttle Challenger. Because the Morton-Thiokol slide used all capital letters, the slide was difficult to read. Unfortunately, the presentation was critical. (Pages 225-226) Citation for slide: Report to the President on the Space Shuttle Challenger Accident, vol. 4 (Washington, D.C.: Presidential Commission, 6 June 1986), p. 646. Morton-Thiokol Presentation to NASA January 27, 1986

48 point 36 point Choose a type size that is easy to read posters presentation slides Information about lettering size in scientific writing can be found on pages 224-225. When showing this slide, I tell the students the story of a symposium in which one audience member in the large lecture hall became so disgruntled with the presenters, who simply photocopied their 12-point papers onto overhead transparencies, that he stood up in the middle of one presentation, pulled out a pair of binoculars, and focused it on the screen. The rest of the audience, who could not see what was on the screen, soon noticed this man with the binoculars and began laughing. Given the commotion, the presenter just turned off the overhead projector and began speaking without transparencies. I have no sympathy for this presenter--showing transparencies that the audience cannot read is impolite. titles text footnotes

In your layouts, use white space for association, emphasis, and hierarchy headings space for margins Discussion appears on pages 226 and 227. space for illustrations

Follow the format that is expected or required for the situation This slide is a conclusion slide for this presentation and emphasizes that students will have to learn what format is expected for each writing situation. Shown as a reinforcing example are two pages of a journal article. Citation for example article: Radomsky, R., and Thole, K. A., 2000, “High Freestream Turbulence Effects in the Endwall Leading Edge Region,” Journal of Turbomachinery, vol. 122, pp. 699-708.