1. Scholarship Skills Andrew BlackLecture 8 1 Scholarship Skills Andrew Black Lecture 8 – Examples, References, Boxes and Citations David Maier © 1996, 1997, 1999, 2000 Some material © Todd Leen, 2001, Andrew Black 2007–8

2. Scholarship Skills Andrew BlackLecture 8 2 Example s One of the most important parts of a paper. good examples can make up for other sins readers can often induce definitions, algorithms, proofs from good examples examples are a way for the reader to fix concepts in his or her mind I have seldom seen a paper with too many examples. We’ll look at various kinds of examples.

3. Scholarship Skills Andrew BlackLecture 8 3 The Motivating Example Comes before the formal description of a term, algorithm, method to “set the stage”. don’t use notation that is not yet introduced Core Rule: Define terms when they are first used. the example should be easier to understand than the concept it illustrates. Can also illustrate the problem you are trying to solve.

4. Scholarship Skills Andrew BlackLecture 8 4 Illustrative Example Demonstrates a concept, method, theorem that has been introduced previously. keep it nearby the definition in the text. consider putting it between theorem and proof do a substantive, not trivial, case If there is a possibility of misinterpretation by the reader, choose an example that will disambiguate. “non-example” helps, too — an example where a theorem doesn’t apply because the conditions are not met. This can help to clarify the conditions under which the theorem holds. Can also use this to show applicability of algorithms. Clarifying example is similar — distinguishes between similar concepts.

5. Scholarship Skills Andrew BlackLecture 8 5 World’s Worst Example Definition. Consider a database containing the relations R 1, R 2,..., R k. Let R(A 1, A 2,..., A n ) be one of these relations, or the natural join of any subset of these relations, and let R* be the transitive closure of relation R. Then if (a 1, a 2,..., a n )R*(a 1, a 2,..., a n ) for any tuple (a 1, a 2,..., a n ) of R, then R is said to be a cyclic relation and the database is called a cyclic database. Example 8.1. The relation { 〈 a,b 〉, 〈 b,a 〉 } is cyclic

6. Scholarship Skills Andrew BlackLecture 8 6 Example Definition: A simple path in an undirected graph is a sequence 〈 v 1, v 2,..., v k 〉 of vertices, k ≥ 1, where 〈 v i, v i+1 〉 is an edge for 1 ≤ i < k, and v i ≠ v j if i ≠ j. 〈 1,2,5,6 〉 and 〈 1,2,3,4 〉 are simple paths. The sequence 〈 1,2,4 〉 is not a simple path because there is no 〈 2,4 〉 edge. The sequence 〈 4 〉 is a simple path, with k=1. The sequence 〈 2,1,3,2,5 〉 is not a simple path because vertex 2 is repeated. 2 346 5 1

7. Scholarship Skills Andrew BlackLecture 8 7 Running Example A single example that is used several times throughout the text can be effective, since reader has less investment in time per concept illustrated can be hard to write as you go. It can be hard to foresee all the points that need to be illustrated.

8. Scholarship Skills Andrew BlackLecture 8 8 “Pun” Examples Avoid examples that come from the domain that you are writing about using a user interface tool to build the interface for a user interface tool a logic program for interpreting logic programs The point is that you shouldn’t use something the reader doesn’t understand to explain something the reader doesn’t understand. If you can find an example outside of computer science, great! Beware of tired examples Printing “Hello, world”. However, there can be “standard” examples

9. Scholarship Skills Andrew BlackLecture 8 9 Illustration s Have a lexicon in mind for your charts. That is: know what your arrows and boxes mean. Consider telling the reader! Query Trans- late Algebra Expr Optmize Phys. Plan Eval. DB Answer Perhaps use ellipses for data Use different arrow and box shape to distinguish DB access

10. Scholarship Skills Andrew BlackLecture 8 10 Citations What do you need to cite? Typically, not common knowledge found in introductory texts—the reader is likely to be familiar with the material and will not mistake it for your own. If you’re writing a review article, or trying to establish an historical thread, you might cite familiar material. In contrast, if material might be unknown, or from an obscure source, or should be credited as the work of another, then you need a citation.

11. Scholarship Skills Andrew BlackLecture 8 11 Citation Style Usually use in-line citation in brackets [14] or [AHU74] or [Aho and Ullman, 1974]. Format may be dictated by journal or conference proceedings. If not: choose one style and stick to it. If you use numbered citations, then use square brackets since parentheses may be confused with equation numbers. Fifty-three percent of cars (13) Treat a citation as parenthetical material, not as a noun. How can you tell? Aho and Ullman [14] give a more general formulation of the algorithm.

12. Scholarship Skills Andrew BlackLecture 8 12 Citation Style It’s usually a good idea to mention the authors! Last name usually enough. Use first name or initial to disambiguate. Don’t use titles (Dr., Professor) Sethi [16] proves the converse is false. P. Fischer [17] proved that generalized tic-tac- toe is NP-Hard; M. Fischer [18] showed it is actually NP-complete. Don’t start a sentence with a numbered reference [16] proves that the converse is false

13. Scholarship Skills Andrew BlackLecture 8 13 Citations are not words

14. Scholarship Skills Andrew BlackLecture 8 14 Frequency and Location Generally don’t need to re-cite in the same paragraph. Reps and Horwitz [20] present the design of a structured editor. They also observe that sometimes non-structured editing is easier [20].

15. Scholarship Skills Andrew BlackLecture 8 15 Location of Citation Not a single right place for a citation, but there are wrong places. Morris and Pratt [4] present an algorithm for string matching, which has sublinear behavior. Morris and Pratt present an algorithm for string matching with sublinear behavior [4].

16. Scholarship Skills Andrew BlackLecture 8 16 Location of Citations Location should be appropriate so information content is clear Several researchers have reported good results, but the two negative reports were from studies on much larger populations [14,18,19,25,38,42]. Several researchers have reported good results [14,18,19,42], but the two negative reports [25,38] were from studies on much larger populations.

17. Scholarship Skills Andrew BlackLecture 8 17 Groups of Papers and Authors If the text says the same thing about a list of citations, group the citations. Miller [23], Rabin and Karp [24], and Ng [25] have analyzed this randomized algorithm. Several authors [23,24,25] have analyzed this... Several authors [Miller 1975, Rabin and Karp 1981, Ng 1983] have analyzed...

18. Scholarship Skills Andrew BlackLecture 8 18 Groups of Papers and Authors If you use et al. (3 or more authors), list only one author. Aho et al. [12] proved that the conjecture is false. Aho and colleagues [12] proved...

19. Scholarship Skills Andrew BlackLecture 8 19 Groups of Papers and Authors Group and order citations. [17][27] ➠ [17, 27] [27,17] ➠ [17, 27] [17,18,19] ➠ [17–19] Usually put citations in the order given in the reference list. The reference list is the list of cited reference gathered together at the end of the paper. If you use numbers, the reference list should be in numerical order. If you use names (e.g., “Bumpte [1975] showed” or “Bumpte [Bu75] showed”) the reference list should be alphabetical. Some publications (IEEE Software, Software—Practice & Experience) require that the reference list is ordered by citation. \bibliographystyle{unsrt} BibTeX doesn't do this for you!

20. Scholarship Skills Andrew BlackLecture 8 20 Side Bars and Boxes Boxes or Sidebars present text that does not integrate directly into the main narrative. It may be preliminary material, or enrichment material. Material in boxes is often tangential to main text. Boxes are used like figures and tables.

21. Scholarship Skills Andrew BlackLecture 8 21 Boxes, continued Boxes can be used to reproduce material from other sources. Sets it off from the main text Shows that it is not your own work Be sure to include citations and sources! This is often called a credit line. Boxes should be numbered, just like figures and tables. This can depend on the “house style” Boxes should have a title.

22. Scholarship Skills Andrew BlackLecture 8 22 Boxes, continued Like figures and tables, each box should be “called out” in the main text. An example that Tim found quite effective: An Architecture for Extensible Code Models by Daniel Vainsencher and Andrew P. Black. http://www.cs.pdx.edu/~black/publications/ModelExtensions_1.64.pdf The reviewers didn’t! compare with http://www.cs.pdx.edu/~black/publications/ModelExtensions.pdf http://www.cs.pdx.edu/~black/publications/ModelExtensions.pdf

23. Scholarship Skills Andrew BlackLecture 8 23

24. Scholarship Skills Andrew BlackLecture 8 24 Final Reminder Use some words following equations, figures, and examples. You should tell the readers the important conclusion they should draw from the equation or graph. Don’t assume that they’ll get the thrust: make it clear. This also forces you to interpret results, rather than just state them. This is generally good intellectual process. It forces you to think about the results.

25. Scholarship Skills Andrew BlackLecture 8 25 References Goals: make clear what the source is; make it reasonably easy for the reader to obtain it. Seems as if each journal or organization has its own style. We will talk about van Leunen’s style, with a couple of suggested changes. Three Basic parts: I. Author. II. Title. III. Bibliographic Info.

26. Scholarship Skills Andrew BlackLecture 8 26 Examples Book Marla Scott. Effective Programming in C. Addison-Wesley, 1992. Journal paper Craig Chambers and Guy T. Leavens. Type checking and modules for multimethods. ACM Transactions on Programming Languages and Systems 17(6), pages 805-843, November 1995.

27. Scholarship Skills Andrew BlackLecture 8 27 Examples 2 Proceedings paper S. Heiler and A. Rosenthal. G-Whiz, a visual interface for the functional model with recursion. Proceedings of the XI International Conference on Very Large Databases, pages 11-23, Stockholm, Sweden, August 1985.

28. Scholarship Skills Andrew BlackLecture 8 28 Examples 3 Article in collection Umeshwar Dayal and John M. Smith. PROBE: A knowledge-oriented database system. In M. C. Brodie and J. Mylopoulos, editors, On Knowledge Based Management Systems, pages 81-93, Springer-Verlag, New York, 1986.

29. Scholarship Skills Andrew BlackLecture 8 29 Getting the Information Right Get information from: the title page of a book the first page of an article. Copy the cover of the proceedings with the paper! Paper titles Make sure that proper names are capitalized Finding hamiltonian circuits using pascal. Usually, the style has its own ideas about capitalization. Usually capitalize after a colon, unless the subtitle only describes the kind of paper. The stable-marriage problem: a parallel solution. The stable-marriage problem: an informal survey.

30. Scholarship Skills Andrew BlackLecture 8 30 Web Pages Problem—lack of author, title or date Problem—transitory nature Robert Burns. Spiders on the web. URL: http://www.dead- poets.com/arachnid.html; revised 12 December 1886, accessed July 2001http://www.dead- poets.com URLs must include a protocol specifier

31. Scholarship Skills Andrew BlackLecture 8 31 Web Pages 2 Another example University of Chicago, Department of Economics. Our favorite Nobel prizes. http://www.econ.uc.edu/nobelhttp://www.econ.uc.edu/nobel, version of 13 January 1999. Check out these websites: http://www.columbia.edu/cu/cup/cgos2006/ basic.html#webpage http://www.cas.usf.edu/english/walker/mla.ht ml

32. Scholarship Skills Andrew BlackLecture 8 32 Instead: The Columbia Guide to Online Style By Janice R. Walker, Todd W. Taylor Edition: 2, illustrated Published by Columbia University Press, 2006 Original from the University of Michigan Digitized May 19, 2008 ISBN 0231132107, 9780231132107 288 pages

33. Scholarship Skills Andrew BlackLecture 8 33 Manuals Cite a manual as a book, with company as author if no person is listed. MassStore, Inc. DiscPac 2000 Installation Guide. 2400 Briarcliff Road, Gary, Indiana 50304, July 1988.