Writing your thesis with our LaTeX-Template [1em][width=3cm]img

67
Writing your thesis with our L A T E X-Template Thesis Howto-Guide Part 2 Benjamin Fritz 10. Dezember 2013

Transcript of Writing your thesis with our LaTeX-Template [1em][width=3cm]img

Writing your thesis with ourLATEX-Template

Thesis Howto-Guide Part 2

Benjamin Fritz

10. Dezember 2013

Requirements

The solution: Working with LATEXGet LATEXinstalledInitial ConfigurationUsing TEX

Our template for youTemplate elementsDe-clutter your thesis in style

Outro

Requirements

The solution: Working with LATEXGet LATEXinstalledInitial ConfigurationUsing TEX

Our template for youTemplate elementsDe-clutter your thesis in style

Outro

What do you need?

A document of 80+ pages

What do you need?

Correct citations

What do you need?

automatic listse.g.

I table of contentsI list of figuresI list of tablesI list of theses, proofs and definitionsI list of abreviationsI glossaryI bibliography

What else do you need?

Read the the master thesis guidelines:http://informatik.hochschule-heidelberg.de/fakultaet/prufungsamt-2/master-thesis-guidelines/

While some of these criteria apply to all thesis-works, someare subject to your supervisors demands.

e.g. The precise citation-style.

Shipwreck ahead?

To fulfill these requirements takes quite some amount of workin any editor.

It will be all too easy to make costly mistakes.

e.g.Manual bibliographies + last minute =Bad looking + incomplete =loss of points = bad idea

Distraction ahead?

Distraction ahead!

Writing the text in a WYSIWYG-editor(like Microsoft-Word)

will distract you

from the actual writing

by always

shoving the layout in your face

What is Good Layout?

Good Layout is charming...

... it’s a pleasure to behold.

Good Layout is charming...

... it puts its spell on you.

Requirements

The solution: Working with LATEXGet LATEXinstalledInitial ConfigurationUsing TEX

Our template for youTemplate elementsDe-clutter your thesis in style

Outro

Advantages of LATEX

I no distractionsI concentration on the pure text

Getting things done

Advantages of LATEX

Professional layout andTypography

Advantages of LATEX

Automatic lists

You need any of these?I table of contentsI list of figuresI list of tablesI list of theses, proofs and definitionsI list of abreviationsI glossaryI bibliography

No problem with LATEX!

Advantages of LATEX

Our complete Thesis-template

Requirements

The solution: Working with LATEXGet LATEXinstalledInitial ConfigurationUsing TEX

Our template for youTemplate elementsDe-clutter your thesis in style

Outro

Get LATEXinstalled

I Get TexliveI Install an editor (like texmaker)I install XINDY (to create automated glossaries)

installation of texLive 2013

First you need to download the1. go to

http://mirror.ctan.org/systems/texlive/tlnet2. download ”install-tl.zip” and unzip it3. in the unzipped folder, locate ”install-tl.bat” and start it

for more info visit http://www.tug.org/texlive/doc/texlive-en/texlive-en.html#installation

For info on installing on other systems:http://www.tug.org/texlive/

Install-wizzard

A plethora of options

Words of advice (1)

Do you really need African scripts? Czech, Greek andItalian language-support? No? Then de-select all languagesyou don’t speak or intend to learn in the future

Words of advice (2)

I Select the option ”Humanities Packages” if you need:I to ”format bible citations”I ”Citations of judgements and official documents in

(German) juridical documents” and similarI Do you intend to ”Typeset guitar chords”? Always wanted

to ”Produce song books for church or fellowship”? Thenselect the ”Music-packages” !

I You write in ”Mongolian ’horizontal’ (Xewtee Dorwoljin)script”? Like to have ”A pair of Georgian fonts” at yourdisposal? - Install the ”omega-package”!

Otherwise: Don’t. Save yourself the wait and yourmachine the download.

Next: Install an editor

e.g. TeXMaker

TeXMaker - an editor

Go tohttp://www.xm1math.net/texmaker/download.html anddownload and install it.

More info on TeXMaker:http://www.xm1math.net/texmaker/

XINDY - for your glossary

1. download and install Xindy:http://www.fys.ku.dk/~tlinnet/xindy-win.exe

2. advanced info:http://www.xindy.org/documentation.html

Requirements

The solution: Working with LATEXGet LATEXinstalledInitial ConfigurationUsing TEX

Our template for youTemplate elementsDe-clutter your thesis in style

Outro

Initial configuration

You only need to do these steps once.

Configure Texmaker (Part I)

I open texmakerI go to ”options”, ”configure Texmaker”I select the commands-tabI ensure that ”built-in viewer” and ”embed” are selected

Configure Texmaker (Part II)

I select the quick-build-tabI ensure that ”PDFLatex + Asymptote + PDFLatex +

View PDF” is selected

This ensures that listings are compiled completely in one run.

Configure Texmaker (Part III)

I select the commands-tabI ensure that ”wordwrap”, ”completion” and ”line numbers”

are enabled

Configure Texmaker (Part IV)

I go to ”User”, ”User Commands”, ”Edit User Commands”I select command 1I set Menuitem to makeglossariesI set Command to makeglossaries %

Configure Texmaker (Part V)

Now you can create a glosssary by either:I clicking ”user” ”user commands” ”1: makeglossaries”I or pressing Alt+Shift+F1 and then F1

(optional) define a build-processI open a simple text-editor (like notepad)I go to ”options”, ”configure Texmaker”. select the

commands-tabI copy and paste the content of the following fields into the

editor and sparate each entry with a pipe-symbol (|)(Make sure to have all text in a single line)

I PdfLaTeXI Bib(la)texI (instead fo the content of a field you write here:)

makeglossaries %I PdfLaTeX (... yes again)I External Viewer

I copy this one line from the editorI in Texmaker go to ”Quick Build”I select ”user” and paste the text into the text-field there

(optional) using that build process

Now you just need to press ”F1” to start all these functions.

If you try to run this on a document that does not have abibliography or a glossary, you will encounter an error.To cope, just go into the options-menu and select theoption ”PdfLaTeX + Asymptote + PdfLaTeX + ViewPdf”.

Configure Texmaker - more info

I Getting started: a tutorialhttp://www.xm1math.net/texmaker/doc.html

I LATEX-Wikibook:http://en.wikibooks.org/wiki/LaTeX/

Requirements

The solution: Working with LATEXGet LATEXinstalledInitial ConfigurationUsing TEX

Our template for youTemplate elementsDe-clutter your thesis in style

Outro

general usage (Part I) Quick-Build

Write a document and then compile it to create a PDF to lookat. This takes just a few seconds.In TeXMaker just hit the F1-key for a quick compile.Alternatively click on ”Quick Build” in the toolbar.

general usage (Part II) Bibliography and Glossary

Use F11 to compile a bibliography and Alt+Shift+F1 tocreate the glossary. Or select ”BibTeX” or ”1: makeglossaries”in the dropdown and click the arrow:

general usage (Part III) Overall process

So you can either:I do all the clicks as described orI just press ”Alt+Shift+F1” then ”F11’ and then ”F1” orI define a build-process and then just press ”F1” (see above

”Initial Configuration”)

Getting started on editing with Texmaker

I An interesting tutorial:http://www.xm1math.net/texmaker/doc.html(highly recommended as an into)

I some sample-material can be found in thesamples-collection in the Thesis-Template.

Requirements

The solution: Working with LATEXGet LATEXinstalledInitial ConfigurationUsing TEX

Our template for youTemplate elementsDe-clutter your thesis in style

Outro

Download the template

For your convenience we developed a template for TEXthat covers it all.Just download the file, unzip it and start working with it:

http://informatik.hochschule-heidelberg.de/thesis-creation-with-tex/

The official template...

I ... it is officially aproved by the School of InformaticsI ... offers you a wide range of reliable tools and listings to

complement your workI ... gives your thesis with LATEXan optically pleasing andprofessional layout

I ... enables you to make the most out of your thesis

Requirements

The solution: Working with LATEXGet LATEXinstalledInitial ConfigurationUsing TEX

Our template for youTemplate elementsDe-clutter your thesis in style

Outro

Template elements - comments

The document contains comments explaining the functionalityof the components.Just go through it from top to bottom and read the commentsif you want to find out how it works. There are plenty ofoptional goodies hidden in comments.

Enjoy

Template elements - Variables

The titlepage and affidavit are created automatically.All you need to do is enter the relevant data into thevariables at the beginning of the document (after line 53).

Template elements - language (Part I)

The thesis is in english per default.

So if you want it in english, just skip the next two slides.

Template elements - language (Part II)

To translate the automatic elements in the document togerman:

I uncomment the inclusion of the ”babel”-package in thepreamble (line 4)

I look into the translations-segment and follow theinstructions there (line 76)

I uncomment the inclusion of ”title_page_DE” and”affidavit_DE” at the beginning of the document andcomment out ”title_page_EN” and ”affidavit_EN” (lines122 onward)

I uncomment the content of the”Zusammenfassung”-segment (lines 457 to 471)

Template elements - language (Part III)

Now you replace the titles of the parts and sections (like”Introduction” or ”Body of Work”) with the proper germanterms.

Congratulations! Your thesis now talks fluent german!

Template elements - acronyms

1. The acronym-definition (from line 106)2. The acronym in the Text (see samples-area)3. The list of acronyms (automated)

Same procedure for the glossary-entries. (definition, usage inthe text, listing) (For details read the wikibook)

Template elements - Acknowlegements-page

optional acknowlegements (from line 140)

Template elements - Samples

Abstract with samples (a. is the last part you change so youwon’t accidentially have the samples in the finished document)

Template elements - german abstract

There is a German version of the abstract (from line 456 on)

Requirements

The solution: Working with LATEXGet LATEXinstalledInitial ConfigurationUsing TEX

Our template for youTemplate elementsDe-clutter your thesis in style

Outro

Clear structure

_aux (auxillary-folder don’t mind)biblio folder for bibliographiesimg folder for images

literature folder for downloaded literature sourcesmaterials folder for all additional materialthesis.pdf the final PDF filethesis.tex the working document

citing

You can use the bibliography in the ”biblio”-folder

graphics: use the img-folder

”/img” here you have the images. (the path is known to thetemplate, so just throw every picture in this subfolder andrefer to the graphics in your document by their filename)

Various material

Just put it all in the ”materials”-folder.How to include PDFs in the Thesis? - look into the samples.

Glossaries with Xindy

Xindy = indexing program

Pattern for abbreviations and index-entries:1. Definition2. Usage in the Text3. Listing (automated)

This template includes automatic listings for index-entries andabbreviations. For guidance on creating definitions and referingto them in the text see:http://en.wikibooks.org/wiki/LaTeX/Glossary#Defining_glossary_entries

Requirements

The solution: Working with LATEXGet LATEXinstalledInitial ConfigurationUsing TEX

Our template for youTemplate elementsDe-clutter your thesis in style

Outro

By the Way

This presentation was made:I on WindowsI entirely with LATEXI using TeXMaker

I just had to use the document-class ”beamer” and put thecontents of each slide in a container named ”frame”For more info see:http://en.wikipedia.org/wiki/Beamer_(LaTeX)

General Sources

I Getting started:http://www.xm1math.net/texmaker/doc.html

I LATEX usage Wikibook:http://en.wikibooks.org/wiki/LaTeX/

I This presentation and more can be found onhttp://informatik.hochschule-heidelberg.de/thesis-creation-with-tex/

I the masterthesis-guidelines: http://informatik.hochschule-heidelberg.de/fakultaet/prufungsamt-2/master-thesis-guidelines/

Setup-specific sourcesI TeXLive

I general: http://www.tug.org/texlive/I download:http://mirror.ctan.org/systems/texlive/tlnet

I more info: http://www.tug.org/texlive/doc/texlive-en/texlive-en.html#installation

I TeXMakerI info: http://www.xm1math.net/texmaker/I download:http://www.xm1math.net/texmaker/download.html

I Xindy (for your glossaries)I info: http://www.xindy.org/documentation.htmlI initial configuration:http://en.wikibooks.org/wiki/LaTeX/Glossary#Compile_glossary_-_In_windows_with_texmaker

Thanks for your attention and enjoy working on your thesis