neeraj goel dept. of computer science and engineering

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

Upload: others

Post on 11-Dec-2021

1 views

Category:

Documents


0 download

TRANSCRIPT

Documentation and LATEX

Neeraj Goel

Dept. of Computer Science and Engineering

Indian Institute of Technology Delhi

LUG@IITD Seminar

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

What is documentation

Applications and letters

E-mails (official or personal)

Project reports

Design documents

Thesis

Technical papers

LUG@IITD Seminar

What is documentation

Applications and letters

E-mails (official or personal)

Project reports

Design documents

Thesis

Technical papers

LUG@IITD Seminar

Major softwares for documentation

Microsoft Word

Open office

Abiword

Notepad/Wordpad - a simple text file

LUG@IITD Seminar

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Demo : Tutorial 2

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

LUG@IITD Seminar

Demo : Tutorial 3

You have learned:Making presentations using prosper

LUG@IITD Seminar

Thank You

Thank You

LUG@IITD Seminar