Top Banner
Documentation and L A T E X Neeraj Goel Dept. of Computer Science and Engineering Indian Institute of Technology Delhi LUG@IITD Semina
22

Neeraj Goel Dept. of Computer Science and Engineering ...

Dec 11, 2021

Download

Documents

dariahiddleston
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: Neeraj Goel Dept. of Computer Science and Engineering ...

Documentation and LATEX

Neeraj Goel

Dept. of Computer Science and Engineering

Indian Institute of Technology Delhi

LUG@IITD Seminar

Page 2: Neeraj Goel Dept. of Computer Science and Engineering ...

Outline

What and Why of documentation

Why LATEX

A simple LATEX document and demo

Figures, tables, math and fonts

Presentation in prosper

LUG@IITD Seminar

Page 3: Neeraj Goel Dept. of Computer Science and Engineering ...

What is documentation

Applications and letters

E-mails (official or personal)

Project reports

Design documents

Thesis

Technical papers

LUG@IITD Seminar

Page 4: Neeraj Goel Dept. of Computer Science and Engineering ...

What is documentation

Applications and letters

E-mails (official or personal)

Project reports

Design documents

Thesis

Technical papers

LUG@IITD Seminar

Page 5: Neeraj Goel Dept. of Computer Science and Engineering ...

Major softwares for documentation

Microsoft Word

Open office

Abiword

Notepad/Wordpad - a simple text file

LUG@IITD Seminar

Page 6: Neeraj Goel Dept. of Computer Science and Engineering ...

Common formatting mistakes..

Improper font sizes - too big for title, too small for section orsubsection

Non-uniform fonts - All sections are not in same font size orshape

References - not in proper order, format

Page layouts - some pages are half filled and some are full

LUG@IITD Seminar

Page 7: Neeraj Goel Dept. of Computer Science and Engineering ...

Common formatting mistakes..

Improper font sizes - too big for title, too small for section orsubsection

Non-uniform fonts - All sections are not in same font size orshape

References - not in proper order, format

Page layouts - some pages are half filled and some are full

LUG@IITD Seminar

Page 8: Neeraj Goel Dept. of Computer Science and Engineering ...

Common formatting mistakes..

Improper font sizes - too big for title, too small for section orsubsection

Non-uniform fonts - All sections are not in same font size orshape

References - not in proper order, format

Page layouts - some pages are half filled and some are full

LUG@IITD Seminar

Page 9: Neeraj Goel Dept. of Computer Science and Engineering ...

Common formatting mistakes..

Improper font sizes - too big for title, too small for section orsubsection

Non-uniform fonts - All sections are not in same font size orshape

References - not in proper order, format

Page layouts - some pages are half filled and some are full

LUG@IITD Seminar

Page 10: Neeraj Goel Dept. of Computer Science and Engineering ...

Where time and effort goes in

Indexing - keeping chapter, section, subsection, figure indexin proper order

What if I have to add a new section or subsection

Making table of content, list of figures and tables

Managing figures and written space

Writing formulas

Making figures

To give document a good look

LUG@IITD Seminar

Page 11: Neeraj Goel Dept. of Computer Science and Engineering ...

Where time and effort goes in

Indexing - keeping chapter, section, subsection, figure indexin proper order

What if I have to add a new section or subsection

Making table of content, list of figures and tables

Managing figures and written space

Writing formulas

Making figures

To give document a good look

LUG@IITD Seminar

Page 12: Neeraj Goel Dept. of Computer Science and Engineering ...

Where time and effort goes in

Indexing - keeping chapter, section, subsection, figure indexin proper order

What if I have to add a new section or subsection

Making table of content, list of figures and tables

Managing figures and written space

Writing formulas

Making figures

To give document a good look

LUG@IITD Seminar

Page 13: Neeraj Goel Dept. of Computer Science and Engineering ...

Where time and effort goes in

Indexing - keeping chapter, section, subsection, figure indexin proper order

What if I have to add a new section or subsection

Making table of content, list of figures and tables

Managing figures and written space

Writing formulas

Making figures

To give document a good look

LUG@IITD Seminar

Page 14: Neeraj Goel Dept. of Computer Science and Engineering ...

Where time and effort goes in

Indexing - keeping chapter, section, subsection, figure indexin proper order

What if I have to add a new section or subsection

Making table of content, list of figures and tables

Managing figures and written space

Writing formulas

Making figures

To give document a good look

LUG@IITD Seminar

Page 15: Neeraj Goel Dept. of Computer Science and Engineering ...

Where time and effort goes in

Indexing - keeping chapter, section, subsection, figure indexin proper order

What if I have to add a new section or subsection

Making table of content, list of figures and tables

Managing figures and written space

Writing formulas

Making figures

To give document a good look

LUG@IITD Seminar

Page 16: Neeraj Goel Dept. of Computer Science and Engineering ...

Where time and effort goes in

Indexing - keeping chapter, section, subsection, figure indexin proper order

What if I have to add a new section or subsection

Making table of content, list of figures and tables

Managing figures and written space

Writing formulas

Making figures

To give document a good look

LUG@IITD Seminar

Page 17: Neeraj Goel Dept. of Computer Science and Engineering ...

LATEX : Need of other documentation software

Writer should focus on writing without being distracted byvisual presentation of document

LATEX is document markup language

Basic featuresTypesetting journal articles, technical reports, books,and slide presentations.Control over large documents containing sectioning,cross-references, tables and figures.Typesetting of complex mathematical formulas.Automatic generation of bibliographies and indexes.Advanced typesetting of mathematics, Multi-lingualfonts

LUG@IITD Seminar

Page 18: Neeraj Goel Dept. of Computer Science and Engineering ...

A simple LATEX file

\documentclass{article}

\title{Cartesian closed categories and the price of eggs}

\author{Jane Doe}

\date{September 1994}

\begin{document}

\maketitle

Hello world!

\end{document}

will produce something like this:

Cartesian closed categories and the price of eggsJane Doe

September 1994Hello world!

LUG@IITD Seminar

Page 19: Neeraj Goel Dept. of Computer Science and Engineering ...

Demo : Tutorial 1

You have learned:Major part of a LATEX documentUsing sections and titleUsing itemizeUsing simple math equationsCompilation of a LATEX document

LUG@IITD Seminar

Page 20: Neeraj Goel Dept. of Computer Science and Engineering ...

Demo : Tutorial 2

You have learned:Use of document class and including packagesUsing subsections and subsubsectionsMaking tablesMore mathsIncluding figuresUsing bibliography

LUG@IITD Seminar

Page 21: Neeraj Goel Dept. of Computer Science and Engineering ...

Demo : Tutorial 3

You have learned:Making presentations using prosper

LUG@IITD Seminar

Page 22: Neeraj Goel Dept. of Computer Science and Engineering ...

Thank You

Thank You

LUG@IITD Seminar