diff --git a/Ch.00_Abstract.tex b/Ch.00_Abstract.tex new file mode 100644 index 0000000000000000000000000000000000000000..9db175295a50a479a4aaafedb42f99330fd698a1 --- /dev/null +++ b/Ch.00_Abstract.tex @@ -0,0 +1,26 @@ +% \begin{abstract}{finnish} + +% Tämä dokumentti on tarkoitettu Helsingin yliopiston tietojenkäsittelytieteen osaston opin\-näyt\-teiden ja harjoitustöiden ulkoasun ohjeeksi ja mallipohjaksi. Ohje soveltuu kanditutkielmiin, ohjelmistotuotantoprojekteihin, seminaareihin ja maisterintutkielmiin. Tämän ohjeen lisäksi on seurattava niitä ohjeita, jotka opastavat valitsemaan kuhunkin osioon tieteellisesti kiinnostavaa, syvällisesti pohdittua sisältöä. + + +% Työn aihe luokitellaan +% ACM Computing Classification System (CCS) mukaisesti, +% ks.\ \url{https://dl.acm.org/ccs}. +% Käytä muutamaa termipolkua (1--3), jotka alkavat juuritermistä ja joissa polun tarkentuvat luokat erotetaan toisistaan oikealle osoittavalla nuolella. + +% \end{abstract} + +\begin{otherlanguage}{english} +\begin{abstract} +Write your abstract here. + +In addition, make sure that all the entries in this form are completed. + +Finally, specify 1--3 ACM Computing Classification System (CCS) topics, as per \url{https://dl.acm.org/ccs}. +Each topic is specified with one path, as shown in the example below, and elements of the path separated with an arrow. +Emphasis of each element individually can be indicated +by the use of bold face for high importance or italics for intermediate +level. + +\end{abstract} +\end{otherlanguage} diff --git a/Ch.10_Introduction.tex b/Ch.10_Introduction.tex new file mode 100644 index 0000000000000000000000000000000000000000..7258ea2103dc3b9db1f302c0550947f92716f086 --- /dev/null +++ b/Ch.10_Introduction.tex @@ -0,0 +1,2 @@ +\chapter{Introduction\label{intro}} + diff --git a/Ch.20_Methods.tex b/Ch.20_Methods.tex new file mode 100644 index 0000000000000000000000000000000000000000..fb7208c52c706912d4b30d170efbeed8e2ece2e5 --- /dev/null +++ b/Ch.20_Methods.tex @@ -0,0 +1 @@ +\chapter{Methods\label{methods}} diff --git a/Ch.30_Results.tex b/Ch.30_Results.tex new file mode 100644 index 0000000000000000000000000000000000000000..a0d09b5117ea9be2c5d98b2a17669255970b101c --- /dev/null +++ b/Ch.30_Results.tex @@ -0,0 +1 @@ +\chapter{Results\label{results}} diff --git a/Ch.40_Discussion.tex b/Ch.40_Discussion.tex new file mode 100644 index 0000000000000000000000000000000000000000..1acbb1ade2508968ac188967140a540d4bc6f8ab --- /dev/null +++ b/Ch.40_Discussion.tex @@ -0,0 +1 @@ +\chapter{Discussion\label{discussion}} diff --git a/Ch.90_Appendix_1.tex b/Ch.90_Appendix_1.tex new file mode 100644 index 0000000000000000000000000000000000000000..178aa4632b6f655fd558605d883f96a0096b64c2 --- /dev/null +++ b/Ch.90_Appendix_1.tex @@ -0,0 +1,4 @@ + +\appendix{Sample Appendix\label{appendix:sample}} + +You can add one or more appendices to your thesis. diff --git a/instructions/bsc_english_contents.tex b/instructions/bsc_english_contents.tex new file mode 100644 index 0000000000000000000000000000000000000000..c04482a274f61490955eae2995e331b3f39e8b4d --- /dev/null +++ b/instructions/bsc_english_contents.tex @@ -0,0 +1,371 @@ + +\chapter{Introduction} + + +In all writing for publication, the writer's freedom of creation and expression are limited by a number of guidelines and specific regulations. + +At best, a familiar set of regulations shared by reader and writer can create a kind of support network that allows the message to be relayed without distortion. It will be easier for readers to find +the pertinent contents in a piece of writing if its layout and structure are the same as they are used to. This also applies to writers. When writers follow a set presentation model, +they do not have to waste time on considerations that are secondary to the work itself, but they can concentrate on polishing the contents of the text. This means that it is a good +idea to practice following the rules for the layout, though you may think you know how to select a better way to present your work. + +This is a guide for the layout and structure of theses and essays at the Department of Computer Science at the University of Helsinki. It is thus applicable to the course +Scientific Writing, the software engineering projects, seminars, and MSc theses. (This is an updated version of +the previous guide written by the course lecturers \citep{erkio01, erkiomakela96, erkio94, verkamo92}.) + +The \LaTeX\ guide and \LaTeX\ style that has been published on the department's web site can be used as support for this guide. + + +\chapter{Structure} + +Let us start by looking at the sections expected to be in a scientific text. Keep in mind that the same expectations go for all kinds of technical writing. +However, this document in itself, is not a scientific or a research +text, so there will be content lacks in terms of research question +setting in the introduction and evaluative material in the last sections. + +\section{Abstract or summary} +%\enlargethispage{5mm} + + +The summary page contains the following elements: the bibliographical data of the work, an abstract, topic classification, +and the key words. The bibliographical data consists of title, name of the author, place of publication, date of publication, and number of pages. + +The abstract should be short, generally one paragraph (100 words maximum) explaining the main contents of the work: topic, methodology and results. + + + Topics are classified according to the ACM Computing Classification System +(CCS). A small set of paths (1-3) should be used, starting from any top nodes +referred to bu the root term CCS leading to the leaf nodes. The elements +in the path are separated by right arrow, and emphasis of each element individually can be indicated +by the use of bold face for high importance or italics for intermediate +level. The combination of individual boldface terms may give the reader +additional insight. + +\section{Introduction} + + +The purpose of the introduction is to introduce the goals of the work in general terms. Describe topic, +methodology and results (as in the abstract, but expand it). +In order to provide the reader a good starting point for +interpretations, it is good to start the introduction by +contextualisation of the challenges and solutions to be discussed. For +example, why a certain domain has a particular challenge and who are +intended to benefit from the solutions proposed. + +The length of the introduction depends on the length of the whole work. A few pages of text does not need a +separate introduction, since it is an expanded summary in itself. The introduction to a 10-page text can +be 1--1.5 pages long. For a 50--70-page MSc thesis, a 2--4-page introduction seems reasonable. + +The introduction should shortly describe the problem field of the whole work, the plot, and the conclusions, +in general terms. After reading it, the reader may decide whether to go deeper into the topic by reading the whole text. + + +\section{Topic chapters} + +The nature of the matter at hand determines how the topic chapters are disposed. +In order to guide the reader, it is a good idea to start each main chapter with a short paragraph +on what the main topic of the chapter is and how it progresses from one sub-chapter to the +next. Especially relevant is to express how concepts, challenges, +solutions and research steps are bound together. There should be enough +guidance for the reader to allow expectation of the right storyline. + + +Basic rule for easy to follow text is to use the natural emphasis of the +text structure to support the content matter key concepts and thought +processes. This means using openings of sectiosn and text paragraphs for +key arguments and information moves, while the internal parts of +paragraps are filled with supporting aspects that those less familiar +with the topic area need. Those with better background knoweldge can +quickly skim trhough the text without loosing any essential arguments. + +Each author has his or her personal ryhtm in the text, which is visible +for the reader as the length of text paragraphs and complexity of +thought chains within. A good policy is to take only one information +move or transition per paragraph. This way the text stays easy to follow. + +Signs of problems with the disposition of the text are easily seen in texts +with only one sub-chapter, or with more than two chapter levels (main and sub-chapters). There may be justifiable reasons to use three-level +headings in some technical documents. Single sentence text paragraphs +are also to be avoided. + + + +%\pagebreak +\section{Reference usage} + + +Relevant learning targets include superficial knowledge of several +citation styles and capability (and willingness) to follow a given +style and ordering of entires and bibliographical details in the list of references. +These aspects are essential as the approval of a PhD manuscript or +journal article may depend on them. + +Disregard of which style you use, +references are always placed inside sentences. This means that e.g. a separate reference at the end of a paragraph would be inappropriate. + +The structure of the text must clearly show what the reference relates to. At the same time, it +shows how long a piece of the text that the reference relates to. + +Efficient positions for citations are right after the introduction +(definition) of a concept, a methods or such, or in the end of a claim +from the reference material. Furthermore, if quoting verbatime one must +use citation marks. + +The text structures and wordings, in addition to the location of +ciations must clearly express whether claims or arguments are +authors' own, or if they come from the contribution of others. Thus is +is of bad style to open a section by listing the citations on which the +section is based on. Such method can further indicate more serious +problems like following reference material as it is instead of analysing +and synthetising material into new though processes. + + +\section{Conclusion} + +At its simplest, a conclusion is merely a weak revision of the main points of the text. All more valuable +conclusion sections contain comments on e.g. the value of results, how the work relates to its environment, or +future visions. This kind of evaluations should be well-grounded in fact, though, or the conclusion +might inadvertently seem comical. + +\section{Creating the list of references} + +The following guidelines should be followed when creating lists of reference for the +assignments during the course Scientific Writing. + +The guidelines are backed by two main goals: to make it as easy as possible to find the +referenced source, and to show what kind of evaluation process the referenced work has undergone. For these reasons +\begin{itemize} + +\item the reference notes should always be so exact that the source can be recognized and found in catalogues and libraries + +\item different types of sources (monographs, conferences, journals) have to be easy to distinguish from each other, and + +\item the different parts of the list must conform to each other, especially for each source type. +\end{itemize} + + +Independent of the citation style in use, +the sources are listed alphabetically according to the author's name, and works by the same +author (group of authors) in the order in which they have been published. If some publication +does not have an individual writer, it is alphabetized according to its name. + + +The following information should be given on each source independent of +the citation style: +\begin{itemize} +\item +Name(s) of author(s) (surname, initial letters of first names) in the original order; if there are more +than three authors, we can write the name of the first author and {\em et al.} instead of the other names. + +\item +the name of the publication or article in its original form + +\item +place of publication: + +\begin{itemize} + +\item +of monographs: publisher, place of publication (can be omitted if the publisher is well known), year +\item +of journal articles: name of journal, volume, issue, year and month (in parenthesis) + +\item +of articles from article collections (such as conference publications): +\begin{itemize} + +\item name of collection, editor, publisher, place of publication and year + +{\em or} + +\item conference name, coordinator, place and time, + +\end{itemize} + +\item +of a report: series, report number, place, publisher and year + +\item +of a web source: URL, validity date, possibly the date when referenced in square brackets + +\end{itemize} + +\item +page numbers, if the source is an article or constitutes a chapter in a compilation. +\end{itemize} + + +When using web sources, you should keep in mind that the threshold for publication on the web +is non-existent. It is better to concentrate on the publications of well-known scientific +publishers and the technical standards for which the web is the only publication channel. If +the same publication is available on paper, refer to that primarily and add the URL as a complement. + + +The list of references gives an example of a text that has been published through many +channels~\citep{abiteboul,dietinger}and another example that shows a standard that has +been disseminated only through the web~\citep{bray}. For web-based +references it is important to give both the publication date and the +time of reading and interpreting the material. The content is prone to +change, and dating your use, you protect your interpretations for +unnecessary accusations of being faulty, if it is known which version +you used. + + + +The list of references for a text should list exactly the sources that the text refers to. +The list of references for this text is an example of how to present sources, +which is why it contains ''extra'' sources. + + +In any style, +put a full stop after the name of a publication or article, as well as after the bibliographical +data of each reference. Separate the other pieces of information with a comma. As is normal in +Finnish, only the first letter of the first word in the heading is capitalized, but in the titles of +conferences and compilations, each major word is capitalized (not articles or prepositions). See the +appended example for a model. For the sake of clarity, it is best to write {\em In the work} before +the name of a compilation, except in the case of conference publications where the name starts with +the abbreviation {\em Proc.} (for Proceedings). In such cases, no complement is necessary. You can +see the difference by comparing the layouts of the references ~''\citep{dantowsley90}'' and~''\citep{gannonetal89}'' . +In case of other citation styles, it is likely that you can trust the +results given by the automated reference management tools. + +\chapter{Layout} + +This chapter discusses the main issues of the technical presentation of a text. + + +\section{Disposition of text sections} + + +Each text should include a separate cover page, as in this model. The second page contains an +abstract, followed by a table of contents (on one or more pages), and then the main text. +Pagination starts on the first page of the main text (with the Arabic numeral 1). (Rigorous writers +leave out the number from the first page.) All the (numbered) headings and their page numbers should be +written into the table of contents. Many word-processing systems create the table of contents automatically +so that the writer does not have to worry about updating page numbers as the work progresses. If writers +wish to, they can paginate the table of contents and previous pages separately (with Roman numerals), e.g. like this model. + +After the main text, but as part of the text body, comes the list of references; its heading is +not numbered. Any possible appendices are added after the list of references, with headings and internal page numbers. + +%\enlargethispage{5mm} + +If you want to make a coherent list of figures, algorithms and tables, this list should be placed i +mmediately after the table of contents. The value of such lists is a matter of opinion, so there +is no need to create one --- especially if your word-processing software does not support it --- unless your instructor explicitly asks for it. + +If for some special reason you want to add an alphabetical index top your work, it should be placed after +the list of references and before appendices. An index should be noted in the table of contents, as s +hould the list of references (unnumbered chapter). Writers who want to create an index should use the automatic support their word-processing system offes. + +\section{General text layout} + +Nowadays you may plan your text to be printed on single side or double +side, with line spacing one, for the final copy. + +For reviewing and feedback purposes, check with your readers for their +preferences. Most read and comment on paper and need some space for +marking. +For drafts you can use wide margins too. +Both margins should also be fairly broad (ca.~3~cm): the wider left margin is needed for binding the text and the +right one for the instructor's comments. Leave enough space (2--3~cm) at the top and bottom, as well. + +The most effective way to distinguish features like chapters, figures, etc, is to have enough space +in your text. Separate paragraphs from each other with one and chapters with a few empty lines. If a +new chapter is about to start at the bottom of a page (with only one or two lines of text), it is better +to start it on the next page. However, it is not necessary to start every chapter on a new page, especially +not with a short text; if the text contains many pages that are nearly empty, readers might suspect that the +writer has tried to make it look longer than it is. + + +Any empty space may be utilized for displaying figures and tables. Especially if a text is written with the +same type of text throughout, empty lines are necessary for separating e.g.~text from tables. Empty space +is cheap, but adds to the clarity and readability of a text. + +\section{Figures and tables} + +%\enlargethispage{5mm} + +All figures and tables should be placed as near the (first) place in the text that refers to them, but +not before this reference. The text should also explain what the writer wants to illustrate with the +figure. Figures can be interpreted in many different ways, so the reader needs guiding. + +Figures should never be placed immediately under the heading of a chapter, but chapters should always +start with text. Figures should not be placed in the middle of a paragraph (much less a sentence), except +if the figure is placed at the top or bottom of a page and it is clear that the paragraph continues. + +Figures do not always have to be placed immediately after the paragraph that refers to them. If there is +not enough space for a figure on the same page as the paragraph that refers to it, the rest of the page +should not remain empty, Though the figure is inserted on the following page. However, the figure should +never be more than one page away from the reference. + + +The image~\ref{kuvaesimerkki} shows how to present a figure. You must pay attention to the visibility of +figure parts and text, to the numbering of figures, and captions. + +\begin{figure}[ht] +%\begin{figure}[tbh] t= top, b = bottom, h=here +\ \newline +\begin{center} +\includegraphics[width=0.9\textwidth]{kuvaesimerkki.pdf} +%\rotatebox{90}{\includegraphics[scale=.75]{kuvaesimerkki.pdf}} +\caption{Figure elements.} +\label{kuvaesimerkki} +\end{center} +\end{figure} + + +We must also pay attention to the size of figures. Any annotations must be clear and easy to read When +presenting performance curves, for example, the axels have to be named, the scale notated, and the units +clearly presented. If you present many things with similar figures, you should use the same scale for easy comparison. + +The caption of a figure should be written underneath it, and it is preferable that it be short and to +the point than too explicit. The same goes for table captions. + +Figures and tables should be numbered progressively. In long texts, two-level numbering should be +used (e.g. Figure 3.1) according to the chapter number, but in shorter texts, one-level numbering is good enough. + + +You should pay attention to presenting figure and table captions consistently, as well as to punctuation +marks. It is natural to put a full stop after a caption, since they are most often full sentences. + +(The style for figure and table captions vary according to publisher and publication. The recommendations +at the Department of Computer Science also seems to vary with respect to where the caption should be placed.) + + +\section{Headings} + +You can use a different font in headings than in the rest of the text, or underlining, larger fonts, or other +methods of emphasis, but generally it is preferred that you only use one of these methods, because if there are +very many font types and sizes, the layout looks messy. The format of headings must be consistent throughout +the text. You should not use any unnumbered ''extra'' headings. + + +\section{Using this model} + +You can use this text as a model for the layout of your own assignment. The font types and sizes, +line spacing, etc vary according to word-processing system, so small deviations from the rule are acceptable. + +The directive number of pages for written assignments given during the lectures for the Scientific-writing +course and in this guide are applicable to assignments with a layout like this guide's (font size 12 points). The +average line in this text should consist of about 80~characters and one page about 30~lines. The number of pages +includes the text itself and the list of references (the part paginated with Arabic numbers), not the +cover page, summary, or table of contents. + +\chapter{Conclusion} + +This text is a checklist for some of the rules governing written presentations, which you should +keep in mind when writing exercises and theses. + +This collection of advise has been compiled by staff members as the +result of discussions on general good writing habbits in computer +science. The consensus is that all young researchers and academic degree +holders must be able to seek and follow instructions of layout and +structuring of texts depending on the contribution they are working on. +This set of instructions aims at unifying the looks of theses and other +study reports from the department, but it is also a representative of +the instruction sets students will meet later. + +This set of instructions only address the looks of the document. Other +instructions must be sought, read and gained experience with in order to +learn to select the suitable semantical contents for the scientific texts. diff --git a/instructions/bsc_finnish_contents.tex b/instructions/bsc_finnish_contents.tex new file mode 100644 index 0000000000000000000000000000000000000000..bda4e3605c1daf05e71608f77514d2491f206629 --- /dev/null +++ b/instructions/bsc_finnish_contents.tex @@ -0,0 +1,506 @@ +\chapter{Johdanto} + + +Kaikessa julkaistavaksi tarkoitetussa tekstissä kirjoittajan luomisen ja +esitystavan vapautta rajoittavat monet ohjeet ja tarkatkin määräykset. + +Parhaimmillaan lukijalle ja kirjoittajalle yhteinen, tuttu säännöstö luo +eräänlaisen tukiverkoston, joka tukee sanoman siirtymistä vääristymättä. +Kirjoituksen lukija löytää kirjoituksesta helpommin olennaisen sisällön, +jos kirjoituksen ulkoasu ja sisällön rakenne vastaavat hänen +tottumuksiaan. Sama koskee myös kirjoittajaa. Noudattaessaan valmista +esitystapamallia kirjoittajan ei tarvitse käyttää aikaansa itse työn +kannalta toissijaisten seikkojen miettimiseen, vaan hän voi keskittyä +hiomaan tekstin sisältöä. Siksi kannattaa harjoitella myös työn ulkoasua +koskevien ohjeiden noudattamista, vaikka omasta mielestään osaisikin +valita esitykselleen ohjetta paremman muodon. + +Tämä kirjoitus on tarkoitettu Helsingin yliopiston +Tietojenkäsittelytieteen osastoon alempien opinnäytteiden ja +harjoitusten ulkoasun ja rakenteen ohjeeksi. Ohje soveltuu siten +kandidaatintutkielman kirjoittamisen kurssille, ohjelmistotuotantoprojekteihin, seminaareihin ja +pro gradu -tutkielmiin. (Kirjoitus on päivitetty uusintapainos aiemmista +ohjeista, jotka kurssin luennoijat ovat laatineet \citep{erkio01,erkiomakela96,erkio94,verkamo92}.) + +Tyylimäärittely on saatavissa pdflatex- ja word-versiona. +Tyylimäärittelyitä valitessa on huomattava ohjeet tekstien syöttöön +liittyvässtä koodauksesta (UTF8,ISO 8859-15). +Tämän kirjoituksen tukena sopivat käytettäväksi tavanomaiset latex- tai +word-oppaat. + +\chapter{Kirjoituksen rakenne} + +Tarkastellaan aluksi tieteelliseltä tekstiltä odotettuja +kirjoituksen osia. Samoihin asioihin on luonnollisesti syytä +kiinnittää huomiota myös muussa teknisessä kirjoittamisessa. Huomattakoon, että tämä teksti ei ole tieteellinen teksti, eikä siten itse sisällä kaikkia niitä elementtejä, jotka tieteellisen tekstin sisällölliseen antiin kuuluvat. Tällaisia puutteita ovat esimerkiksi johdannon tutkimuskysymyksen asettelun puuttuminen sekä arvoivan materiaalin puute tekstin lopussa, sekä yhteenvedon latteus. +Teksti rajoittuu siten otsikkonsa mukaisesti vain tekniseen sisällön asetteluun. + +\section{Tiivistelmä} + + + +Tiivistelmäsivu sisältää seuraavat osat: työn bibliografiset tiedot, +tiivistelmäteksti, aiheluokat ja avainsanat. Bibliografiset tiedot +koostuvat työn otsikosta, tekijän nimestä, julkaisupaikan tiedoista, +julkaisuajankohdasta ja sivumäärästä. + +Tiivistelmäteksti on lyhyt, yleensä yhden kappaleen mittainen +(maksimissaan noin 100 sanaa) selvitys +kirjoituksen tärkeimmästä sisällöstä: mitä on tutkittu, miten on +tutkittu ja mitä tuloksia on saatu. + + +Aiheluokat kuvataan ACM Computing Classification System -luokituksen (CCS) +luokituksen mukaisesti. Luokittelussa käytetään täysia polkuja juurisolmun CCS osoittamista lähtöposteistä lehtisolmuihin. Polkuja voi antaa 1-3 aihepiirien soveltuvuuden mukaan, mitä alempi opinnäyte, sen vähemmän polkuja se tarvitsee. +Poluissa tasot erotetaan toisistaan nuolella eteenpäin. Kun polun nimisanoja arvioidaan suhteessa työn sisältöön, merkitään boldface-fontilla tärkein termi, italics-fontilla toiseksi tärkein. Näin menetellään, mikäli jotkin termeistä ovat olennaisesti paremmin kuvaavia kuin muut polun termit. Nimettyjen polkujen lisäksi lukija voi siten tarkastella lisäulottuvuutena myös tärkeiksi merkittyjen termien joukkoa sinänsä. +Avainsanoiksi valitaan kirjoituksen sisältöä +keskeisesti kuvaavia käsitteitä. + +\section{Johdanto} + + +Johdannon tarkoituksena on kertoa yleiskielisesti +työn tavoite. Kerrotaan (kuten tiivistelmässäkin, mutta laveammin), +mitä on tutkittu, miten on tutkittu ja mitä tuloksia on saatu. +Jotta kysymyksenasettelu ja tulokset on lukijan helppo oikein tulkita on syytä aloittaa johdanto asettelemalla tutkimus asiayhteyteensä, esimerkiksi kertomalla aluksi, minkälaisessa yhteydessä tarkasteluun otettavat haasteet esiintyvät ja keiden on ratkaisuista tarkoitus hyötyä. + +Johdannon pituus määräytyy suhteessa koko kirjoitelman pituuteen. +Parisivuinen kirjoitus ei erikseen otsikoitua johdantoa kaipaa, sillä +se itsessään on laajennettu tiivistelmä. Kymmensivuisen +kirjoituksen johdanto voi olla vaikkapa sivun tai puolentoista +mittainen. Pro gradu -tutkielman 50-70-sivuiseen kokonaisuuteen +tuntuu 2-4-sivuinen johdanto kohtuulliselta. + +Johdanto kertoo siis lyhyessä, yleistajuisessa muodossa +koko kirjoitelman kysymyksenasettelun, juonen sekä tulokset ja johtopäätelmät. +Tämän luettuaan lukija voi päätellä, haluaako syventyä asiaan tarkemmin +lukemalla koko kirjoituksen. + + +\section{Käsittelyluvut} + +Käsittelylukujen työnjako määräytyy käsiteltävän asian luonteen +mukaisesti. +Lukijan ohjailemiseksi kukin pääluku kannattaa aloittaa lyhyellä +kappaleella, joka paljastaa mikä kyseisen luvun keskeisin sisältö on ja +kuinka aliluvuissa asiaa kehitellään eteenpäin. +Erityisesti kannattaa kiinnittää huomiota siihen, että lukijalle ilmaistaan selkeästi miksi kutakin asiaa käsitellään ja miten käsiteltävät asiat suhtautuvat toisiinsa. + +Jäsentelyongelmista kielivät tilanteet, joissa +alilukuja on vain yksi, tai joissa käytetään useampaa kuin +kahta tasoa (pääluku ja sen aliluvut). Kolmitasoisia +otsikointeja saatetaan tarvita joissakin teknisissä +dokumenteissa perustellusti, mutta nämä muodostavat poikkeuksen. + +Perusohjeena on käyttää tekstin rakenteellisesti painokkaita paikkoja, +kuten lukujen avauksia ja teksikappaleiden aloitusvirkkeitä +juonenkuljetukseen ja informaatioaskeleiden sitomiseen toisiinsa. +Tekstikappaleiden keskiosat, samoin kuin lukujen keskiosat selostavat +asiaa vähemmän tuntevalle yksityiskohtia, kun taas aihepiirissä jo +sisällä olevat lukijat voivat alkuvirkkeitä silmäilemällä edetä +tekstissä tehokkaasti eksymättä tarinan juonesta. + +Kullakin kirjoittajalla on oma temponsa, joka välittyy lukijalle +tekstikappaleiden pituudessa ja niihin sisällytettyjen ajatuskulkujen +mutkikkuudessa. Kussakin tekstikappaleessa pitäisi pitäytyä vain yhdessä +informaatioaskelessa tai olennaisessa päättelyaskelessa, muuten juonen +seuraaminen käy raskaaksi olennaisten lauseiden etsiskelyksi. Yksivirkkeisiä +tekstikappaleita on syytä varoa. + + + +\section{Lähdeviittausten käyttö} + + +Olennaisia opittavia asioita viittaustekniikoissa ovat viitteen paikka +tekstissä, oikea lähdeluettelojärjestys valitun viitetyylin parina sekä +taito ja tahto noudattaa annettua tyylimääräystä. Väitöskirjoissa ja +lehti- tai konferenssiartikkeleissa tekstin hyväksyminen riippuu myös +näiden yksityiskohtien asianmukaisesta käsittelystä. Tästä syystä +laitoksella nähdään tarpeelliseksi opiskelijoiden tutustua edes +pinnallisesti myös muihin tyylilajeihin ja oppia käyttämään +automatisoituja muotoilutyökaluja tehokkaasti, jolloin tyylimuutokset +ovat tehokkaita. + +Lähdeviitteet sijoitetaan aina virkkeen sisäpuolelle. Siten esimerkiksi +tekstikappaleen lopussa irrallaan oleva viite ei ole asiallinen. Tilanne +ei muutu, vaikka viite sujautettaisiin tekstikappaleen viimeisen +virkkeen sisään. +Lähdeviittauksen yhteyteen merkitään mukaan tarkentavat +sivunumerot, mikäli lukijan olisi työlästä löytää asianomainen kohta +viitatusta lähteestä. + + +Tehokkaita viitteensijoittelupaikkoja ovat esimerkiksi uuden käsitteen +nimeämiskohta ja virkkeen loppu kun kyseessä on lähteestä lainattu +väite. On myös muistettava lainausmerkkien käyttö silloin kun tehdään +suoria lainauksia. + +Tekstin jäsentelyn on tuotava selkeästi esiin, mihin asiaan viite +liittyy. Samalla tulee ymmärrettäväksi se, kuinka pitkään +tekstikatkelmaan ko. viite liitetään. Ei ole siten asiallista aloittaa +lukua nimeämällä yhtä tai useampaa lähdettä luvun taustaksi, vaan +viitteitä on kiinnitettävä täsmällisemmin väitteisiin ja käsitteisiin. +Luvun avaus viitetiedolla voi olla oire myös suuremmasta ongelmasta: +lähderiippuvuudesta. Aloitteleva kirjoittaja helposti toistaa lähteestä +oppimaansa ilman että tarpeellinen analysointi ja prosessointi suhteessa +muuhun opittuun olisi vielä tapahtut. + +Viitteillä ja sanamuodolilla on +myös tuotava selkeästi esiin se, mikä teksissä on lainattua ja mikä oman +pohdinnan ja valikoinnin tulosta. + + +Lähdeviittauksiin käytetään Tietojenkäsittelytieteen osastolla +numeroitua tyyliä ja APA-tyyliä, valinnan näiden välillä tekevät kunkin +ryhmän valvoja ja ohjaaja yhdessä. +Numeroitu tyyli on esimerkiksi IEEE- ja +ACM-julkaisuissa yleisesti käytetty ja puolustaa siten paikkaansa. +APA-tyyli on poikkeuksellinen ns. kovissa tieteissä, mutta monet +valvojista pitävät siitä sen luettavuuden vuoksi. Numeroita joutuu nimiä +useammin tarkistamaan lähdeluettelosta, sillä tarkastus- ja +arvointiprosessiin kuuluu arvioida myös lähteiden valitaa ja niiden +käyttötapaa. + + + + + +\section{Yhteenveto} + +Yhteenveto vaatimattomimmillaan on vain lyhyt kertaus kirjoituksen +keskeisistä asioista. Arvokkaamman yhteenvedon saa aikaan kommentoimalla + työn tulosten arvoa, työn liittymistä ympäristöön ja +tulevaisuudennäkymiä. Tällaiset arviot huolellisesti +perusteltava. + +\section{Lähdeluettelon laatiminen} + +Tieteellisen kirjoittamisen kurssin töiden lähdeluetteloiden +laatimisessa noudatetaan seuraavia ohjeita. + +Niiden taustalla on kaksi +keskeistä pyrkimystä: tehdä viitatun lähteen hankkiminen luettavaksi +mahdollisimman helpoksi ja ilmaista, millaisen arviointiprosessin +läpi käyneeseen kirjoitukseen vedotaan. +Näistä syistä +\begin{itemize} +\item lähdeviitteen tulee aina olla niin tarkka, että +lähde on sen perusteella tunnistettavissa ja löydettävissä luetteloista +ja kirjastoista, +\item erityyppisten lähteiden (kirjat, konferenssit, lehdet) on erotuttava +toisistaan +ja +\item luettelon eri osien tulee olla mahdollisimman +yhdenmukaisia, erityisesti lähdetyypin sisällä. +\end{itemize} + + +Riippumatta käytettävästä viitetyylistä, +lähteet ovat Tietojenkäsittelytieteen osaston opinnäytteiden lähdeluetteloissa tekijän nimen mukaisessa aakkosjärjestyksessä, +saman tekijän (tekijäryhmän) työt julkaisuajan mukaisessa +järjestyksessä. Jos jollakin lähteellä ei ole henkilötekijää, se +aakkostetaan julkaisun nimen mukaisesti. + +Kustakin lähteestä annetaan seuraavat tiedot, edelleen viitetyylistä riippumatta: +\begin{itemize} +\item (tarvittaessa lähdeviitelyhenne). +\item +tekijän tai tekijöiden nimet (sukunimi, etunimien alkukirjaimet) +alkuperäisessä järjestyksessään; jos tekijöitä on enemmän kuin kolme, +voidaan toimia siten, että +vain ensimmäinen tekijä nimetään ja muiden tilalle kirjoitetaan {\em et +al.} +\item +julkaisun tai artikkelin nimi alkuperäisessä muodossaan +\item +julkaisupaikan tiedot: +\begin{itemize} +\item +kirjasta: kustantaja, julkaisupaikka (voidaan jättää pois, jos kyseessä +on tunnettu kustantaja), vuosi ja +\item +lehtiartikkelista: lehden nimi, volyymi, numero, vuosiluku ja kuukausi (suluissa), + +\item +artikkelikokoelmassa (esim. konferenssijulkaisussa) ilmestyneestä +artikkelista: +\begin{itemize} +\item kokoelman nimi, toimittaja, kustantaja, julkaisupaikka ja vuosi +{\em tai} +\item konferenssin nimi, järjestäjä, paikka ja aika, +\end{itemize} +\item +raportista: julkaisusarja, raportin numero, julkaisupaikka, julkaisija ja vuosi +ja +\item +www-lähteestä: verkko-osoite, voimassaoloajankohta, mahdollisesti +viittausajankohta hakasuluissa +\end{itemize} +\item +sivunumerot, mikäli lähteenä käytetty julkaisu on artikkeli tai kokoomateoksen itsenäinen luku. +\end{itemize} + +Normaaliin suomalaiseen tapaan artikkelin nimessä ainoastaan +ensimmäinen sana kirjoitetaan isolla alkukirjaimella, sen sijaan +konferenssien ja kokoelmajulkaisujen nimissä käytetään isoa +alkukirjainta jokaisen sanan alussa (artikkelisanoja ja prepositioita +lukuunottamatta). Katso mallia oheisista esimerkeistä. +Kokoelman nimen edessä on syytä selvyyden vuoksi käyttää sanaa {\em +Teoksessa}, paitsi kun on kysymys konferenssijulkaisusta, jonka nimi +alkaa lyhenteellä {\em Proc.} (sanasta Proceedings). Tällöin ei tarvita +mitään täydennystä. +Tämän eron näkee esimerkiksi vertaamalla +lähdeviitteiden~''\citep{dantowsley90}'' +ja~''\citep{gannonetal89}'' ulkoasuja. + +WWW-lähteiden käytössä on syytä muistaa, että verkossa julkaisukynnys on +olematon. Kannattaa siten keskittyä tunnettujen tieteellisten +kustantajien julkaisuihin ja niihin teknisiin standardeihin, joille WWW +on ainoa julkaisukanava. Mikäli sama julkaisu on saatavissa myös +perinteisessä muodossa, viitataan ensisijaisesti siihen ja käytetään +verkko-osoitetta lisätietona. Lähdeluettelossa on annettu esimerkit +useita kanavia julkaistusta kirjoituksesta~\citep{abiteboul,dietinger} sekä pelkästään +WWW-julkaisuna +leviävästä standardista~\citep{bray}. + +Erityisesti varoitetaan Wikipedian käytöstä tieteellisessä tekstissä. +Vaikka sen avulla on helppo alustavasti tutustua joihin aihepiireihin ja +asiantuteva lukija voisi teksin kelvolliseksi tiettynä hetkenä +hyväksyäkin, ei se foorumina millään lailla täytä tieteellisesti +vertaisarvoidun tutkimusfoorumin kriteerejä. +Jos Wikipedia-artikkelia ei mitenkään malta ajankuvana olla mainitsematta, käytettäköön jotain muuta kuin lähdeviitetekniikkaa tähän taiteelliseen otteeseen, vaikkapa alaviitteitä. Olennaista silloinkin on, että tieteellinen sisältö ei tule tällä korvatuksi vaan sen puute korostetuksi. + +WWW-lähteeseen viittaamisessa pätevät samat periaatteet kuin +perinteisiin lähteisiin viitattaessa: lähdeviitteessä ilmaistaan +otsakkeet, kirjoittajat, toimittajat js muut seikat. Eroa on ainoastaan +verkko-osoitteen ja sen voimassaoloajankohdan ilmaisemisessa. Mikäli +lähde on julkaistu ainoastaan verkossa, voidaan web-osoitetta (URL) +käyttää vastaavasti kuin perinteisen julkaisun paikannusinformaatiota +(lehden ja se numeron julkaisutiedot). Lähdeluettelossa on WWW-viittausten yhteydessä aina syytä ilmaista päivämäärä, jolloin linkin voimassaolo ja lähteen sisältö on tarkastettu. +Esimerkkeinä verkkoviitteistä soveltuvat seuraavat: +\begin{itemize} +\item Gergen, Kenneth (1999) Narrative, Moral Identity and Historical +Consciousness: a Social Constructionist Account. +http://www.swarthmore.edu/SocSci/kgergen1/text3.html. Haettu 11.6.1999. +\item +Ritala-Koskinen, Aino and Valokivi, Heli (2006) The Role of Development +Skills in Social Work Practice Education in Finland. Social Work and +Society, The International Online-Only Journal 4(2006)1. +http://www.socwork.net/2006/1/series/transition/ritalakoskinenvalokivi. +Viitattu 30.8.2006. +\item Heinisuo, Rami and Ekholm, Kai (1997) Elektronisen viittaamisen +opas. Jyväskylän yliopiston kirjaston julkaisuja n:o 40. Jyväskylä: +Jyväskylän yliopiston kirjasto. http://www.pori.tut.fi/~multisil/evo/. +Viitattu 29.8.2006. +\end{itemize} + +Kirjoituksen lähdeluettelossa luetellaan täsmälleen ne lähteet, joihin +viitataan kirjoituksen tekstiosassa. Tämän kirjoituksen lähdeluettelo on +tarkoitettu lähinnä esitystavan esimerkiksi, mistä syystä siinä on +''ylimääräisiä'' lähteitä. + + +Pääsääntöisesti julkaisun tai artikkelin nimen perään tulee piste, +samoin kunkin lähteen bibliografisten tietojen perään. Muut tiedot +erotetaan toisistaan pilkulla. Useimmissa tapauksissa +voidaan noudattaa teknisten välineiden antamaa mallia, sillä edellytyksellä, että ylläolevat vaatimukset muuten täyttyvät. + + + +\chapter{Ulkoasulliset seikat} + + Tässä luvussa käsitellään yleisimpiä +tekstin tekniseen esittämiseen liittyviä seikkoja. + +\section{Työn osien järjestys} + + Kirjoituksen alussa on aina +erillinen, mallin mukainen kansilehti. Toisena sivuna on +tiivistelmäsivu, sen jälkeen sisällysluettelo (yksi tai useampia +sivuja) ja sitten varsinainen teksti. Sivunumerointi aloitetaan vasta +ensimmäiseltä tekstisivulta (arabialaisella ykkösellä). (Tarkat +jättävät ykkössivun numeromerkittä.) Sisällysluetteloon merkitään +kaikki (numeroidut) otsikot ja vastaavat sivunumerot. Monet +tekstin\-käsittelyjärjestelmät muodostavat itse sisällysluettelon, +jolloin kirjoittajan ei tarvitse huolehtia luettelon sivunumeroiden +päivittämisestä tekstin kehittyessä. Sisällysluettelo\-sivu ja sitä +edeltävät sivut voidaan haluttaessa numeroida erikseen (roomalaisin +numeroin) esimerkiksi tämän mallin mukaisesti. + +Varsinaisen tekstin +jäljessä, mutta itse työhön kuuluvana on ensimmäisenä lähdeluettelo, +jonka otsikkoa ei numeroida. Lähdeluettelon jälkeen sijoitetaan +mahdolliset liitteet, jotka otsikoidaan ja varustetaan sisäisillä +sivunumeroilla. + + + +Mikäli kuvista, algoritmeista +ja taulukoista halutaan tehdä yhtenäinen luettelo, sijoitetaan +luettelot sisällysluettelon jälkeen. Luetteloiden käyttöarvosta on +eriäviä mielipiteitä, joten niiden laatimiseen ei varsinkaan ilman +tekstinkäsittelyjärjestelmän tukea kannata ryhtyä ilman tarkastajan +erityistä toivetta. + +Mikäli kirjoitukseen erityissyistä halutaan +liittää aakkosellinen hakemisto, sijoitetaan se lähdeluettelon jälkeen +ennen liitteitä. Indeksi merkitään sisällysluetteloon samoin kuin +lähdeluettelo (numeroimaton luku). Mikäli indeksin tekemiseen +ryhdytään, on syytä käyttää tekstinkäsittelyjärjestelmän tarjoamaa +automatiikkaa. + +Teksin luonnollisen juonenkuljetuksen mukana esiin +tulevien käsitteiden määrittelyjen sijasta ei pidä yrittää sen enempää +pakata kaikkia määritelmiä johdantoon kuin laatia johdantoa ennen +käsitelistaa tai lyhenteiden selityslistaa. Kumpikaan ei sovi +tavanomaiseen argumentoivaan tieteelliseen tekstityyliin, vaikka +teknisessä yhteydessä niillä liitteinä voi olla lisäarvoa. + + +\section{Tekstin yleinen sijoittelu} + +Lopullinen tutkielmaversio voi olla yksi- tai kaksipuoleiseksi aseteltua +ja riviväliltään 1,5 tai 1. Erityyppisissä +teksteissä haasteet ja asetteluvaatimukset voivat olla erilaiset. Erota +kappaleet toisistaan yhdellä tyhjällä rivillä tai +käytä tekstinkäsittelytyökalujen ominaisuuksia +hyödyksesi ja määrittele tekstikappaleiden väliin jäävä tila hieman +normaalia riviväliä suuremmaksi. + +Kirjoituksen lukujen, kuvien ja taulukoiden erottumisen kannalta +tärkein keino on riittävän tilan käyttö niiden ympärillä. Kuvan ja +nimekkeen tulee olla selkeästi yksi kokonaisuus, joka eroaa muusta +tyhjän tilan rajaamana. Kuvan tai taulukon on aina numerointinsa ja +nimekkeensä kanssa mahduttava yhdelle sivulle tai varmasti +kaksipuolisena paperidokumenttina tarkasteltavassa tekstissä aukeamalle. +Kuvissa fonttikoko ei saa alittaa 8 pistettä. + + + +Jos uusi luku tulisi alkamaan aivan sivun alareunasta (vain yksi tai +kaksi riviä varsinaista tekstiä), aloita mieluummin uusi sivu. Jokaista +uutta lukua ei kuitenkaan ole tarpeen --- etenkään lyhyessä +kirjoituksessa --- aloittaa uudelta sivulta: jos kirjoituksessa on +paljon melkein tyhjiä sivuja, lukija voi epäillä, että kirjoittaja on +yrittänyt saada kirjoituksensa näyttämään pitemmältä kuin se onkaan. + Tyhjää tilaa kannattaa käyttää hyödyksi myös kuvien ja taulukoiden +yhteydessä. Erityisesti jos kirjoituksessa käytetään kauttaaltaan samaa +tekstityyppiä, tyhjät rivit ovat välttämättömiä erottamaan esimerkiksi +tekstiä ja taulukkoa toisistaan. Tyhjä tila on halpaa, mutta se lisää +selkeyttä ja luettavuutta. + + +\section{Kuvat ja taulukot} + + +Kuva tai taulukko sijoitetaan mahdollisimman lähelle +(ensimmäistä) tekstikohtaa, jossa siihen viitataan, ei kuitenkaan +kyseistä viittausta aikaisemmaksi. +Tekstissä on syytä myös kertoa, mitä kuvalla halutaan havainnollistaa. +Kuvan voi lukea monella eri tavalla, joten lukijaa on ohjattava. + +Kuvaa ei pidä sijoittaa välittömästi luvun otsikon alle, vaan on +aloitettava tekstillä. Kuvaa ei pidä sijoittaa keskelle tekstikappaletta +(saati virkettä), paitsi jos kuva tulee sivun alkuun tai loppuun eikä +kappaleen jatkumisesta tule epäselvyyttä. + +Kuvan ei aina tarvitse olla välittömästi viittaavan kappaleen +perässä. Esimerkiksi viittauskohdan ja +vasta seuraavalle sivulle mahtuvan kuvan väliin jäävää sivun loppuosaa +ei jätetä tyhjäksi. Kuvaa ei kuitenkaan pidä viedä seuraavaa +sivua kauemmas viittauskohdasta. + + +Varsinaista kuvan esittämistä havainnollistaa kuva~\ref{kuvaesimerkki}. +Huomiota on kiinnitettävä kuvan osien ja tekstimerkintöjen näkyvyyteen, +kuvan numerointiin ja otsikointiin. + +\begin{figure}[ht] +%\begin{figure}[tbh] t= top, b = bottom, h=here +\ \newline +\begin{center} +\includegraphics[width=0.75\textwidth]{kuvaesimerkki.pdf} +\caption{Kuvan elementit.} +\label{kuvaesimerkki} +\end{center} +\end{figure} + + +Kuvien kokoon on kiinnitettävä huomiota. Käytettyjen merkintöjen +on oltava helposti luettavissa ja selkeät. Esimerkiksi +suorituskykykäyriä esitettäessä akselit on nimettävä, asteikot +merkittävä ja käytetyt yksiköt tuotava selkeästi esiin. +Samankaltaisia asioita esitettäessä useammalla kuvalla on +syytä käyttää samaa mittakaavaa vertailun helpottamiseksi. + +Kuvan otsikko kirjoitetaan kuvan alle ja sen tulee olla mieluummin lyhyt +ja ytimekäs kuin liian selittelevä. +Samoin toimitaan taulukoiden otsikoinnissa. + +Kuvat ja taulukot numeroidaan juoksevasti. Pitkissä teksteissä käytetään +kaksitasoista numerointia (esimerkiksi Kuva 3.1) pääluvuittain, lyhyissä +riittää yksitasoinen numerointi. + + +Kuva- ja taulukko-otsikoiden yhdenmukaiseen esitystyyliin on syytä kiinnittää +huomiota, samoin mm. välimerkkeihin. Luontevaa on käyttää +kuvatekstin lopussa pistettä, ovathan useimmat kuvateksteistä virkkeitä. + +(Kuvien ja taulukoiden otsikointityyli vaihtelee +kustantajittain ja julkaisuittain. Samoin tuntuu suositeltava käytäntö +Tietojenkäsittelytieteen laitoksen sisällä vaihtelevan taulukon +otsikon sijainnin suhteen.) + + +\section{Otsikot} + +Otsikoissa voi käyttää muusta tekstistä poikkeavaa kirjasintyyppiä, +alleviivausta, suurempaa kirjasinkokoa tms.\ erotuskeinoa, yleensä +kuitenkin vain yhtä näistä, koska kovin monta erilaista kirjasintyyppiä +ja -kokoa tekee ulkoasusta helposti sekavan. Otsikoiden esitystavan on +oltava johdonmukainen läpi koko kirjoituksen. Numeroimattomia +''ylimääräisiä'' otsikoita ei tule yleensä käyttää. + + +\section{Mallin käyttö} + +Voit käyttää tätä kirjoitusta mallina oman opinnäytteesi ulkoasua +varten. Eri tekstinkäsittelyjärjestelmissä käytössä olevat yksityiskohdat kuten +kirjasintyypit ja -koot ja rivivälit poikkeavat toisistaan, joten +pienet poikkeamat ovat toki hyväksyttäviä. + +Tieteellisen kirjoittamisen kurssin luennoilla ja +liitteenä olevassa ohjeessa annetut töiden ohjeelliset sivumäärät +koskevat työtä, joka vastaa ulkoasultaan tätä ohjetta (kirjasinkoko +12~pistettä). Tässä tekstissä keskimääräinen rivin pituus lienee noin +80~merkkiä ja sivun pituus 35-40~riviä. +Sivumääriin lasketaan varsinaisen tekstiosuuden pituus ja lähdeluettelo +(arabialaisin numeroin numeroitu osuus), ei kansilehteä, tiivistelmää +eikä sisällysluetteloa. Sivumääräarviossa otetaan huomioon hyvin vajaat +sivut, joita syntyy paljon lyhyiden lukujen ja taittotyyliin määritellyn +luvun avauksen pakottaminen oikeanpuolimmaiselle sivulle. + +\chapter{Yhteenveto} + +Tämän kirjoituksen tarkoituksena on toimia muistilistana eräistä +esitystavallisista säännöistä, joihin harjoitusten ja tutkielmien +kohdalla on syytä kiinnittää huomiota. + +Annetut ohjeet on laitoksen henkilökunta muotoillut yhdessä keskustellen +ja noudattaen oman tieteenalansa perinteitä. Eri erikoistumisaloilla ja +erilaisillaa määräävässä asemassa olevissa julkaisufooruilla käytänteet +vaihtelevat ja nuorten tutkijoiden onkin tiedostettava ero yleisten +sisältöohjeiden ja teknisten muotoilusääntöjen välillä. Aina tekstin +valmistuessa on tarkastettava erikseen, täyttääkö se annetut +pituusrajoitteet ja vastaako se annettuja muotoiluohjeita, olivatpa ne +kuinka pikkutarkkoja tahansa. Tarkasta sääntöjen noudattamisesta syntyy +yhteinäisyyttä kokoovan julkaisun tasolla, mikä helpottaa lukijoiden +työskentelyä. + +Tämä ohje vastaa vain asettelullisiin kysymyksiin ja sen rinnalla on +syytä tutustua materiaaliin ja luentoihin, joissa keskitytään tekstin +varsinaiseen sisältöön. Olennaisin väline on kuitenkin akateemisesti +pidemmälle ehtineen, jo julkaisuja rakentaneen ohjaajan palaute ja +mentorointi. + diff --git a/instructions/instructions_english.tex b/instructions/instructions_english.tex new file mode 100644 index 0000000000000000000000000000000000000000..b74d9fa3a01d57caedc041e523473d5872d6f111 --- /dev/null +++ b/instructions/instructions_english.tex @@ -0,0 +1,165 @@ + +\appendix{Instructions for LaTex} + +\section{General Setup} + +In the HY-CS-main.tex file you will find the following STEPS 0--5. Below you can find related instructions. +\vspace{0.5cm} + +\textbf{STEP 0 -- Access the thesis template} + +\begin{itemize} +\item Import the thesis template into a new Overleaf project. The easiest way to do it is to: +\begin{itemize} + \item Obtain a zip file of the LaTeX template from the webpage of your programme. + \item Go to \url{https://www.overleaf.com/edu/helsinki} and login to Overleaf with your university credentials. + \item Go to the list of your projects at \url{https://www.overleaf.com/project}, click ``New Project'' and ``Upload Project''., the projects under your account + \item Then upload the zip with the template. + \item You are now ready to write your thesis in Overleaf by editing the template, you can start by renaming the project. +\end{itemize} +\end{itemize} + + +{\textbf{STEP 1 -- BSc or MSc thesis?}} +\begin{enumerate} +\item Select whether your are writing BSc (tkt) or MSc (csm for CS) thesis. +\item Select your language: \texttt{finnish}, \texttt{english}, or \texttt{swedish}. +\item If you are writing MSc select your line / track. +\end{enumerate} + + +{\textbf{STEP 2 -- Set up your personal information}} + +\begin{enumerate} +\item Specify the title of your thesis with \texttt{\textbackslash title\{\}}. +\item Specify your name to the author field with \texttt{\textbackslash author\{\}}. +\item Specify the names of your supervisors of the thesis with \texttt{\textbackslash supervisors\{\}}. +\item Specify the keywords of the thesis with \texttt{\textbackslash keywords\{\}}. +\item Specify the ACM classification terms of the thesis with \texttt{\textbackslash classification\{\}}. See \url{https://dl.acm.org/ccs} for more information. +\end{enumerate} + +{\textbf{STEP 3 -- Write your abstract}} + +\begin{itemize} +\item You can have the abstract in multiple languages with the \texttt{otherlanguages} environment. The example below shows how to provide an English abstract: + +\begin{verbatim} +\begin{otherlanguage}{english} +\begin{abstract} +Your abstract text goes here. +\end{abstract} +\end{otherlanguage} +\end{verbatim} + +\end{itemize} + +{\textbf{STEP 4 -- Writing your thesis}} + +\begin{enumerate} +\item There are some minimal contents and instructions below +\item Remove, or comment out, this appendix from your thesis. +\end{enumerate} + +{\textbf{STEP 5 -- Set your bibliography style}} + +\begin{itemize} +\item The default is Author-Year style (Einstein, 1905), but it can be easily changed to numbered [1] or alphabetical [Ein05] , as the examples of these are in comments. +\item Discuss the style to use with your supervisor. +\end{itemize} + +\section{Bibliography in Latex} + +The bibliography is defined in a separate \texttt{.bib} file. For this template, it is named \texttt{bibliography.bib} and includes the content show in Figure~\ref{bibexamples}. + +Chapter Bibliography lists all the works that you refer to in your text. You refer to the works in the bibliography using an appropriate \emph{citation key}. +% +This thesis template contains an example of a bibliography. + + +References are done using \texttt{\textbackslash citep\{einstein\}}, which generates in text a citation formatted according to the selected style \citep{einstein}, or \texttt{\textbackslash citep\{latexcompanion,knuth99\}}, which generates \citep{latexcompanion,knuth99}. +As an example of a different citations (see how these look in the Latex source), we can write \citep{einstein} to refer to the work written by \citeauthor{einstein} in \citeyear{einstein}, as the work by \citet{einstein} appears in the bilbliography included in this template. + +Note that there are different possible styles for the bibliography and citation keys. +% +Consult your supervisors on the chosen style -- and once you arrive at a preferred style, use it consistently throughout the thesis. + +\begin{figure}[ht] + \centering + \begin{scriptsize} +\begin{verbatim} +@article{einstein, + author = "Albert Einstein", + title = "{Zur Elektrodynamik bewegter K{\"o}rper}. ({German}) + [{On} the electrodynamics of moving bodies]", + journal = "Annalen der Physik", + volume = "322", + number = "10", + pages = "891--921", + year = "1905", + DOI = "http://dx.doi.org/10.1002/andp.19053221004" +} + +@book{latexcompanion, + author = "Michel Goossens and Frank Mittelbach and Alexander Samarin", + title = "The \LaTeX\ Companion", + year = "1993", + publisher = "Addison-Wesley", + address = "Reading, Massachusetts" +} + +@book{knuth99, + author = "Donald E. Knuth", + title = "Digital Typography", + year = "1999", + publisher = "The Center for the Study of Language and Information", + series = "CLSI Lecture Notes (78)" +}\end{verbatim} +\end{scriptsize} + \caption{Examples of bibliographic reference in .bib file.} + \label{bibexamples} +\end{figure} + +%In the last reference url field the code \verb+%7E+ will translate into \verb+~+ once clicked in the final pdf. + +\section{Some instructions about writing in Latex} + +The following gives some superficial instructions for using this template for a Master's thesis. For guidelines on thesis writing you can consult various sources, such as university courses on scientific writing or your supervisors. + +For more detailed instructions, just google, e.g., "Overleaf table positioning", and your chances of finding good info are pretty good. + + +\section{Figures} +Besides text, here are simple examples how you can add figures and tables in your thesis. +Remember always to refer to each figure in the main text and provide them with a descriptive caption. + +Figure~\ref{fig:logo} gives an example how to add figures to the document. +%Using figures is particularly useful to display plots of experimental results. + +\begin{figure}[ht] +\begin{center} +\includegraphics[width=0.3\textwidth]{template/figures/HY-logo-ml.png} +\caption{University of Helsinki flame-logo for Faculty of Science.\label{fig:logo}} +\end{center} +\end{figure} + +\section{Tables} + +Table~\ref{table:results} gives an example of a table. +Remember always to cite the table in the main text, table captions go on top of the table. + +\begin{table}[h] % h positions the table here, t! would force on top of the page, or example. +\begin{center} +\caption{Experimental results.\label{table:results}} % caption is here to make it on top +\begin{tabular}{l||l c r} +Experiment & 1 & 2 & 3 \\ +\hline \hline +$A$ & 2.5 & 4.7 & -11 \\ +$B$ & 8.0 & -3.7 & 12.6 \\ +$A+B$ & 10.5 & 1.0 & 1.6 \\ +\hline +% +\end{tabular} +\end{center} +\end{table} + + diff --git a/instructions/instructions_finnish.tex b/instructions/instructions_finnish.tex new file mode 100644 index 0000000000000000000000000000000000000000..b8562d8365a311aa0af57f93f2f6d44b9e074658 --- /dev/null +++ b/instructions/instructions_finnish.tex @@ -0,0 +1,158 @@ + +\appendix{Tutkielmapohjan käyttöohjeet} +\label{appendix:instructions_finnish} + +\section{Ensiaslkeleet} + +\texttt{HY-CS-main.tex} tiedosto sisältää viisi askelta STEPS 0--5. Alla on kuvattu, mitä nämä askeleet tarkoittavat ja miten niitä seuraamalla luot itsellesi tutkielmapohjan. +\vspace{0.5cm} + +\textbf{STEP 0 -- Kopioi itsellesi tutkielmapohja} + +\begin{itemize} +\item Hae tutkielmapohja uuteen Overleaf-projektiin. Tämä käy helpoiten seuraavasti: +\begin{itemize} + \item Lataa Latex-pohjan zip-tiedosto koulutusohjelman sivuilta. + \item Mene osoitteeseen \url{www.overleaf.com/edu/helsinki} ja kirjaudu Overleafiin yli\-opiston tunnuksillasi. + \item Overleafissa (\url{https://www.overleaf.com/project}), klikkaa ``New Project'' and ``Upload Project''. + \item Valitse lataamasi tutkielmapohjan zip-tiedosto. + \item Nyt voit lähteä kirjoittamaan tutkielmaasi suoraan pohjaan, voit aloittaa esim. vaihtamalla projektin nimen. +\end{itemize} +\end{itemize} + + +{\textbf{STEP 1 -- BSc vai MSc tutkielma?}} +\begin{enumerate} +\item Valitse (tiedostossa \texttt{HY-CS-main.tex}) oletko tekemässä BSc (tkt) vai MSc (csm tietojenkäsittely). +tutkielman. +\item Valitse kieli jolla kirjoitat tutkielman: \texttt{finnish}, \texttt{english} tai \texttt{swedish}. +\item Jos olet kirjoittamassa maisterintutkielmaa, valitse linja/opintosuunta. +\end{enumerate} + + +{\textbf{STEP 2 -- Aseta henkilökohtaiset tietosi}} + +\begin{enumerate} +\item Kirjoita alustava otsikko tutkielmallesi: \texttt{\textbackslash title\{\}}. +\item Kirjoita oma nimesi kohtaan \texttt{\textbackslash author\{\}}. +\item Lisää ohjaajien nimet \texttt{\textbackslash supervisors\{\}}. +\item Määrittele avainsanat \texttt{\textbackslash keywords\{\}}. +\item Määritä tutkielmasi ACM luokittelutermit \texttt{\textbackslash classification\{\}}. Ks. lisätietoa: \url{https://dl.acm.org/ccs}. +\end{enumerate} + +{\textbf{STEP 3 -- Kirjoita tiivistelmä}} + +\begin{itemize} +\item Voit kirjoittaa tiivistelmän (koko tiivistelmäsivu) eri kielillä \texttt{otherlanguages}-ym\-pä\-ris\-tön avulla. Alla esimerkki jolla kirjoitat englanninkielisen tiivistelmän muulla kuin englannin kielellä kirjoitettuun tutkielmaan: + +\begin{verbatim} +\begin{otherlanguage}{english} +\begin{abstract} +Your abstract text goes here. +\end{abstract} +\end{otherlanguage} +\end{verbatim} + +\end{itemize} + +{\textbf{STEP 4 -- Kirjoita tutkielma}} + +\begin{enumerate} +\item Kirjoittamisesta Latexilla löydät hieman ohjeita alempaa. +\item Poista tämä liite, tai kommentoi. +\end{enumerate} + +{\textbf{STEP 5 -- Aseta kirjallisuuslähdeluettelon tyyli}} + +\begin{itemize} +\item Oletustyylin tekijä-vuosi, eli (Einstein, 1905), voit vaihtaa viittaustyylin (tiedostossa \texttt{HY-CS-main.tex}) helposti (eri mallit kommentoituna) esim. numeroituun [1], tai aakkostyyliin [Ein05]. +Lisää ohjeita liittyen viittaustyylin säätämiseen {Bib}\TeX issä löytyy verkosta: \url{https://ctan.org/pkg/biblatex} +\item Sovi käytettävä tyyli ohjaajasi kanssa. +\end{itemize} + +\section{Kirjallisuusviitteet Latexissa} + +Kirjallisuuslähteet ylläpidetään erillisessä .bib-tiedostossa. Tässä tutkielmapohjassa käy\-te\-tyt kirjallisuuslähteet, joista esimerkkejä kuvassa~\ref{bibexamples-fi}, löytyvät tiedostosta\newline \texttt{bibliography.bib}. + +\begin{figure}[ht] + \centering + \begin{scriptsize} +\begin{verbatim} + +@article{einstein, + author = "Albert Einstein", + title = "{Zur Elektrodynamik bewegter K{\"o}rper}. ({German}) + [{On} the electrodynamics of moving bodies]", + journal = "Annalen der Physik", + volume = "322", + number = "10", + pages = "891--921", + year = "1905", + DOI = "http://dx.doi.org/10.1002/andp.19053221004" +} + +@book{latexcompanion, + author = "Michel Goossens and Frank Mittelbach and Alexander Samarin", + title = "The \LaTeX\ Companion", + year = "1993", + publisher = "Addison-Wesley", + address = "Reading, Massachusetts" +} + +@book{knuth99, + author = "Donald E. Knuth", + title = "Digital Typography", + year = "1999", + publisher = "The Center for the Study of Language and Information", + series = "CLSI Lecture Notes (78)" +} +\end{verbatim} +\end{scriptsize} + \caption{Esimerkkejä kirjallisuuslähteiden kuvaamisesta .bib-tiedostossa.} + \label{bibexamples-fi} +\end{figure} + +Viitteet kirjallisuuslähteisiin muodostetaan komennolla \texttt{\textbackslash citep\{einstein\}}, josta generoituu tekstiin valitun viittaustyylin mukaisesti muotoiltu viite \citep{einstein}, tai \texttt{\textbackslash citep\{latexcompanion,knuth99\}}, josta tekstiin puolestaan generoituu \citep{latexcompanion,knuth99}. +Voit kirjoittaa (katso miltä nämä näyttävät Latex lähdekoodissa) \citep{einstein} viitataksesi julkaisuun, jonka on kirjoittanut \citeauthor{einstein} vuonna \citeyear{einstein}, kun vain lähde \citet{einstein} on oikein lisättynä kirjallisuuslähdetiedostossa. + +Tekstissä viitatut kirjallisuuslähteet tulevat automaattisesti viiteluetteloon. Kirjallisuuslähteiden tietojen oikeellisuus ja yhdenmukaisuus .bib-tiedostossa vaikuttavat luonnollisesti siihen, miten tiedot tutkielmassa näyttäytyvät. Tämä on syytä huomioida, sillä esim.\ verkosta valmiiksi {Bib\TeX} muodossa löytyvien tietojen täydellisyyten tai samanmuotoisuuteen ei pidä sokeasti luottaa. + + +Keskustele viittaustyylin valinnasta ohjaajan kanssa. Joitain vaihtoehtoja on osoitteessa:\\ +\url{https://www.overleaf.com/learn/latex/Biblatex_bibliography_styles}. +%\url{https://www.sharelatex.com/learn/Bibtex_bibliography_styles}. + +\section{Joitain ohjeita Latexilla kirjoittamiseen} + +Seuraavassa on joitain ohjeita tämän tutkielmapohjan käyttöön maisterintutkielmassa. Kirjoittamisohjeita löytyy useasta eri lähteestä. Voit esimerkiksi tutustua kandidaatintutkielman ohjeisiin. +Ohjaajan kanssa on hyvä keskustella aikaisessa vaiheessa työn rakenteesta. + +Yksityiskohtaisia ohjeita Latexin käyttämäsestä saa parhaiten hakemalla verkosta, esim. haku englanniksi "Overleaf table positioning" tuottaa oletettavasti aika toimivan vastauksen. + +\section{Kuvat} +Kuva~\ref{fig:logo-fi} toimii esimerkkinä kuvan lisäämisestä työhön. Muista myös viitata jokaiseen kuvaan tekstissä. + +\begin{figure}[ht] % remove [h!] for automatic placement, which is probably better for a thesis with more text on page +\centering +\includegraphics[width=0.3\textwidth]{template/figures/HY-logo-ml.png} +\caption{Helsingin yliopiston logo matemaattis-luonnontieteellisen tiedekunnan värein.\label{fig:logo-fi}} +\end{figure} + +\newpage % just to keep the table on the same page with the short piece of text +\section{Taulukot} + +Taulukossa~\ref{table:results-fi} on esimerkki kokeellisten tulosten raportoinnista taulukkona. Muista myös viitata jokaiseen taulukkoon tekstissä. +\begin{table}[ht] +\centering +\caption{Kokeelliset tulokset.\label{table:results-fi}} +\begin{tabular}{l||l c r} +Koe & 1 & 2 & 3 \\ +\hline \hline +$A$ & 2.5 & 4.7 & -11 \\ +$B$ & 8.0 & -3.7 & 12.6 \\ +$A+B$ & 10.5 & 1.0 & 1.6 \\ +\hline +% +\end{tabular} +\end{table} +