Vtu Final Report Howto
Vtu Final Report Howto
NOTE: Mirror of this page is available here: VLSI Systems Lab. THE LATEST VERSION
IS HERE: ECE Dept..
NOTE FOR IIScians: Looks like Google shows this page when queried for IISc Latex
thesis. Download iiscthes.cls, iisclogo.sty,iiscthes.sty and iisclogo.eps. The page ur looking
for is here: http://etd.ncsi.iisc.ernet.in/instructions/templates.htm.
Ok .. you have done all the hardwork ... You've read infinite (countably infinite.... for the
purists) number of papers .... You've chosen your project topic, finalized a problem,
visualized, designed and implemented/simulated the architecture, run-modify-rerun the
simulation till it fit your theoretical results .... Basically u've finished your MTech project
(you feel so or ur guide is just plain tired) ...
You have to write the report now. The irony of life (or let's say VTU engineering) is .... no
matter how many nightouts you have done trying to debug that 1 crucial error ... no matter
how many papers u have gone through .... you get marks based on ONLY what you write in
your MTECH FINAL REPORT. (except those internal marks where every dumb tom, dick
and harry in the class gets more than you ;) ). And there is some marks allotted for a paper
presented/published at any seminar/symposium/conference/journal.
I've been there ... done that ... Ya .... MTech. from VTU. Not that i prepared the best project
report in VTU's history... but i have gone through enough to make a page giving instructions
about how to write a final report without common errors and stupid mistakes. After going
through the torture of reading this page you should be able to write a tolerably good report
that might save u one or two correction trips to your college and get that prized signature
from your guide on ur report.
Table of Contents
1. Introduction
1. Organization of the rest of the report
2. Organization of the VTU Report
3. The VTU Circular
4. Points to Remember
5. LaTeX
1. LaTeX in LinuX
2. LaTeX in Windows
3. LaTeX Intro
4. LaTeX Examples
6. VTU LaTeX CLASS FILE
7. Final Viva
8. Other Reading
Appendix B. Miscellaneous.
1. Introduction
This page is by a VTUian, for a VTUian. The final report guidelines and other information
here for your use. Every single line in this document is my own personal, trivial,
inexperienced opinion. Use and follow at your risk. Any comments, suggestions to
basavaraj_DOT_talwar_AT_gmail_DOT_com. (Replace the _DOT_ with a . and _AT_
with an '@').
I have written the document for PG students (I was one). Most of this applies to UG too. This
HowTo contains:
1. General guidelines about writing a report based on my own experience. I'm writing
here bcz i couldn't find any at the time of my writing when i desperately needed.
2. Formatting guidelines for the report.
3. LaTeX document class file for preparation of the report. Highly incomplete right now
but does most of the formatting well.
4. This is NOT a report writing tutorial. I created the page just to show off my LaTeX
document class file. Many report writing guides/tutors can be found on the Net.
be. Section 8 gives some misc materials that might help. Download materials required to
prepare your report are all separately put up in Appendix A. Appendix B always contains
matter that is not yet included in the main article - but will be soon after some refinement. I
have written something on Literature Survey right now.
Back to Top
9. Appendix - Index, Glossary and others can be put here (according to my humble
opinion). Also this is the place where the gr8ter beings put their data sheets/circuit
diagrams and other xtreme stuff that don't fit in the body.
Back to Top
Circular - Page 1
Circular - Page 2
Circular - Page 3
Circular - Page 4
Circular - Page 5
Circular - Page 6
Back to Top
4. Points to Remember
Some other important points from the circular are illustrated here.
The report is a hard bound book with a fixed color cover for each department. (My
guess is this requirement is 2 make the life of the clerk easier. ;). I love bureaucracy.)
The color codes are here for your convenience. Example of a cover page is in
Appendix A.
PG Course (Department)
1.
Electrical
PINK
2.
Electronics
PURPLE
3.
Mechanical
SKY BLUE
4.
Civil
GREY
5.
Computer Science
CREAM
6.
Chemical
YELLOW
7.
Textile
BROWN
The report should be A4 size, Executive BOND sheets and hard bound in the
prescribed color for each department. Report should be one sided(not back to back),
and text must have 1.5 spacing at least. Borders:
o Left: 1.25 inches------3.18
o Right: 1.0 inch=-------2.55
o Top: 0.75 inch-------1.90
o Bottom: 0.75 inch
The prologue (everything before the First Chapter begins.) should contain:
o The cover page with necessary details about the report.
o Certificates and Declaration are mandatory.
o Abstract and Acknowledgements.
o Table of Contents, List of Figures, List of Tables and if relevant List of
Algorithms, List of Acronyms, List of Symbols etc.
Reports are divided into Chapters, which in turn into sections, subsections etc.
Chapters have to be numbered 1, 2, .... Sections will be numbered 1.1, 1.2 .....
Subsections will be 1.1.1, 1.1.2 ..... A chapter can contain any number of
figures/tables/equations etc. The first figure in chapter 2 will be numbered 2.1.
The "Chapter 1" text should be either left or right justified. The chapter title should be
Centred. And they have to be of certain sizes:
o Chapter number text: 16pt
o Chapter title: 18pt
o Section title: 16pt
o Subsection title: 14pt
o Report text: 12pt
The last chapter has to be Conclusion and Future work. NOT Conclusions. Should
contain summary of the work and scope for further work. Conventionally it contains 2
sections. The first section is Conclusion and the second section is Future Work.
References should be serially numbered in order of their occurance in the test and
their numbers should be indicated in square brackets. for eg. [3].
Rest of them are just stuff like "Don't copy 4m here and there etc." which you may
ignore as the world knows we all prepare original stuff.
Some important points NOT from the circular are here. Follow them so that you don't have to
make rounds of your college searching for your guide to approve your report more than
once/twice.
The report is a hard bound and a transparent plastic covered sizeable book that wud
look good in your personal library. :). The binding will be done at your (un)official
binders where your seniors have gotten theirs done last year. Also amazingly enough,
he seems 2 know the way the report should look including the color codes of all
departments better than any engineering student. The color codes are given here.
Example of the cover page are in the Downloads Section.
The cover should contain important details about what/where/when of your project
like:
o VTU and the VTU logo: Ofcourse you expand it on the cover, Mr. Engineer.
o Report Title: ofcourse u knew that.
o Your name, USN and branch.
o Names with designation (like Dr. XXX, Prof. YYY or Mr. ZZZ) and
complete addresses of both the guides.
o Complete address of the company/research lab+institution the work was
carried out in.
o Your college logo, name and address.
o Year of submission. Not mandatory though. But wud luk professional.
1 more item my dear friend swears by is the sentence that sounds like "In partial
fulfillment of such a degree in such a university......". Though this is not thaaaaaat
necessary, the purists would include this too. In either case .. i'll try 2 add both
examples in the Downloads section.
Abstract is the expansion of the title. Should not exceed 2 pages and you may fit it in
1 page. (Internal guide's tastes matter here. Usually the abstract should not exceed 1
page according to most.) Usually divided in to 3-4 paragraphs. here goes: Write a very
general paragraph abt the technologies involved. Write briefly and clearly what your
work focusses on. The next section is the summary of the results obtained (Akin to - i
tested it on this and on that and found it works well.). Any paper from a reputed
journal/conference should be an ideal example. Emulate - nothing to be ashamed of.
An example with bad illustration is provided here.
For example: Project title - "Design and Development of Modular System for QoS
Guarantee in Wireless Networks". 1 paragraph about wireless networks, why QoS is
important in wireless networks. Next paragraph talks abt the proposed scheme that
takes advantage of the two existing (opposite) working schemes. Two/three sentences
that give comprehensively the essense/working of the new method. The last paragraph
contains stuff like i have simulated various wireless environments using such a
Network Simulating Tool and found that the method is efficient.
You may look up the abstract in my friends' reports in the downloads section.
The first chapter in the report is an introduction to the work in more ways than one.
Usually named Introduction. Use any name of your choice (if you find one that suits
better). Some sections have become mandatory in VTU reports. More importantly
Literature Survey. This has to be included in the first chapter. Usually after the
general introduction about the technologies involved in the work. You may put it in
the second chapter if you think it fits better there. Somehow it is frowned upon if the
Literature Survey is put later. (My report was rejected bcz i put Literature Survey as
the Fourth chapter.). Refer Related Work sections from reputed journals.
Include matter from (and refer) papers/books and other sources. The works referred
can be previous works(which you may have continued), similar works (they might
have done in wired environments and you have implemented in wireless) or partially
borrowed works (You used one of their algorithms) etc. You get the idea. (I never got
this until my friends explained it thoroughly to me.)
Literature Survey is very important. Referring GOOD, REPUTED JOURNAL/CONF
articles has a LOT of weightage. Take pains to collect references early in your
research.
After the literature survey there is another necessary section called Motivation. This
is your justifaction to your literature survey and work. You will here justify the need
of your work, present consicely and precisely the novelty in your work. It should
contain matter that says something like "i read all these works and i understood the
workings of the system. I also noticed that there is this part missing in these systems. i
decided to work on the missing part." You may also include in the Motivation
something like "all the above works used technology X to implement the algorithms. I
will use technology Y because it seems to be ___________ ."
Important: You _HAVE_ to justify your work properly. If you think noone will read
this and write crap here .... u get shot at in the viva by the external. i have seen many
friend get stuck justifying the need, novelty and quality of their work. This is the first
question asked in every viva. " A lot of ppl have done this b4 you. What is new in this
one?". You have be ready with a satisfactory answer.
Include a section called Proposed Work as the last but one section of the
"Introduction" chapter. Any (technical) person reading this section should get a broad
idea of your complete project. It's paragraphs contain: problem statement, your
approach to the solution, tools you have used to arrive at the results, and finally the
result obtained.
The last section of your first chapter SHOULD be Organization of Rest of the
Report. It contains 4/5 sentences like - Chapter 2 illustrates the architecture of the
Modular System for QoS Guarantee in Wireless Networks...... Summary of the work
with some future research directions are presented in Chapter 6. Glossary of related
terms are listed in Appendix A.
I have always found it easy to start a chapter with an expansion of its title. The second
paragraph contained organization of the rest of the chapter. Then the first section.
The rest of the chapters may correspond to Proposed Work, Implementation, Case
Study. You may add one or two chapters before these if you feel understanding of
other topics are necessary to understand your work. For. eg. My friend worked on a
recent tool called "LabView" and he included a chapter about it before explaining his
own work.
My advice: Take a wise decision in this regard. DONOT compromise the quality of
your report by adding a _LOT_ of general details. Noone is interested in timepass
stuff.
The conclusion is not more than 2 pages (usually) and matter is not very different
from the abstract. Take some time to research and fill the future work section.
Back to Top
5. LaTeX
Now you know the rules. Don't just run away and start MS-Word and start typing. What MSWord does LaTeX (pronounced lay-tech) does a zillion times better. And is a million times
easier. An excellent introduction to latex is given by the latex people themselves here. A good
latex reference is Not so short intro to LaTeX. The latex user guide at the latex project page is
available here. Here's 1 very good book on how to write a thesis in LaTeX. It'll take 30
minutes to learn more than half of LaTeX (and more than half is more than enough to write
more than 100 MTech reports.)
And learning is made easy by a cool latex editor environment called Kile - KDE Integrated
LateX Environment..
And learning is made easy by a cool latex editor environment called Kile - KDE Integrated
LateX Environment.. An even better editor called LYX follows the WYSIWYM paradigm in
text proecessing. It can create PS, PDF, DOC, TEX files from an interface similar to ones in
the standard word processors. I strongly recommend LYX for any1 who is uncomfortable
with the idea of creating and compiling a .tex file, converting it to ps or pdf. However BOTH
editors require some initial knowledge of LaTeX. Most info abt latex in the following
paragraphs should be enough to make a LOT of progress. OpenOffice 2.0 has an export to
LaTeX2e option.
LaTeX is a typetting, text formatting system (language). Similar to HTML at the surface
(there are start and end tags for most tasks). LaTeX was written to give the author freedom
from formatting the text. Trivial stuff like setting the chapter titles to 18 points and putting
them in the centre of the page etc. is handled by LaTeX. A very short intro to LaTeX is
presented here. TeX (a formatting language was written by the Donald E Knuth). LaTeX is a
macro package created by Leslie Lamport to help us mortals to create high quality documents
(ps/pdf among others). A very brief LaTeX tutorial is presented in the following sections.
Tutorial links for LaTeX are presented in Section 5.3 and also in the downloads section.
Every latex source file belongs to a document class. A document class is just a string
that specifies the type of document that is going to be prepared. Important types of
document classes:
o article: For small articles/papers etc. Divided into sections, subsections, and
subsubsections.
o report: For large reports. Divided into chapters, sections, subsections, and
subsubsections.
o book: For books/monographs. Divided into chapters, sections, subsections,
and subsubsections.
o letter: To create letter.
Extra functionalities to LaTeX can be added by including separate packages for each.
For example: graphicx, graphics, epsfig, psfig packages define commands
for inclusion of graphics (types jpg, bmp, eps, ps). glossary.sty helps in producing
good looking glossaries.
One easy way to create images for those who don't want to use xfig or dia is to create
a diagram on open office presenter (or ms-powerpoint) and capture the screenshot, cut
to the required size and convert to EPS.
Do what you want in whichever format you want. The figures have to be separately
available.
Elegant and xtreemly helpful methods exist to create the bibliography. It is very well
explained in the book on how to write a thesis in LaTeX.
report-example.tex: This is the main source file of the report. There can be as many
supplementary source files that are 'included' in the main source file as one wishes.
This is main file is where we define the type of document being prepared, the
packages we require to compile this document etc. Very similar to the main manager
module of ur project implementation ;).
.eps files: Are the figures that are included in the final document. Can be viewed
using any PS viewer (the same ones you use to view the .ps files.)
refs.bib: The file used by bibtex to create the bibliography. More details in the Howto
prepare PhD thesis pdf.
makereport: Just to show the steps to compile, create a ps file and open it. just run
this script. It'll generate the final ps file and show it to you.
The test-chap.tex is for you to add a dummy chapter into the report .... and glossary.sty and
gloss.tex are for the glossary. Instructions can be found in the ps in this directory.
Back to Top
4. Recompile the main tex file and view it. Notice the difference ???? The recompiled
report using vtu.cls is here.
The complete vtu report example directory is here for your reference in TGZ and ZIP
formats. Some points to be noticed in the report using vtu class are:
1. Page borders are set according to the VTU formatting rules requirement.
2. All chapter names are centred. Chapter numbers are right justfied.
3. Mandatory pages such as Abstract, Acknowledgements and Declaration are
generated automatically. Only the matter has to be filled by the candidate.
4. and many other points i'm too lazy to add right now....
7. Final Viva
About the FINAL VIVA and DEMO.
1. Looks like it isn't a rule (that i have heard of) regarding the demo during ur Final viva.
This brings us to conclude that ur viva MAY or MAY NOT have a demo with it.
2. Also, ur final demo during the viva is influenced by these factors:
o If ur internal guide has visited ur project working place and checked d demo
already (like they come 2 ITPL and bug u 2 come and pick them up ..... that is
seriously SICK man.).
o If ur college does not have enough facilities - in which case u as a responsible,
obedient, teacher fearing student should bring the necessary tools to the
college during the demo. Like they get the loaded, installed and ready to fire
CPU to d college 4m d house.
o Interest of the internal/external: It so happens that 99.99% of the externals
don't want to see d demo. They are paid for asking questions (and God help
them do that properly for once) and they don't do anything else. The idea of a
demo is usually the internal guide's. If there is a demo (it is a BIG IF), it is
almost definitely b4 the viva and usually b4 he gives u a go ahead on report
writing.
3. Final viva duration usually lasts 30-45 mins. If u stammer during the Q-A session it'll
prolong even more.
4. Every1's belief that the external exists for the sole purpose of making ur viva
miserable is plain wrong. Externals are in most cases good friends of ur internal
guides. If ur interal guide has a good opinion abt ur work ..... u score.
5. Prepare a precise presentation abt ur work. The presentation should NOT be more
than 30 mins. Don't go on for an hour abt everything that ur team did and ur manager
planned and stuff like that. The presentation should be crisp and about ur work in the
past year.
6. Prepare visually appealing presentations (with quality content in them ;)). Use Beamer
package for latex. This most helpful for those who have written their report in latex.
Beamer makes exceedingly beautiful presentations in PDFs and it'll beat everything u
have seen till date. U may use OpenOffice or other presentation making software.
7. One way u can be sure that the examiners are interested in ur work is when query in
between d presentation without waiting for u to finish d presentation. Take special
interest and answer such queries and u'll earn extra points.
8. A Q-A session follows d presentation. Again it is a misconception that they test ur
"C++" (or whichever area ur project is in) knowledge in this Q-A session. They do
that only if u convince the examiners during ur presentation that u r NOT d original
creator of the work.
9. Overall experience on d viva by MOST of my classmates (including me) is that it is a
general, healthy, technical chit-chat about YOUR work with some prof 4m another
college. that's all. Usually they are impressed ... and usually they award enough
marks. U don't have 2 b extra-ordinary in d viva. But u have 2 have GOOD technical
content to talk and original work to show. They come 2 viva to award u some marks ...
not to screw ur life.
Back to Top
8. Other Reading:
1. Advice on report writing..
2. How to write a doctoral thesis.
3. A note on academic integrity.
4. Acceptable and Unacceptable use of non-original material
5. Literature Survey
.
Back to Top
Appendix B. Miscellaneous.
View and sign my guestbook.
NOTE: Latest Version is here. Mirror of this page is available here..
Literature Survey (LS) exists to help every1 beleive in ur work. It so happens that the
world we live in is a cruel one. Anything u say or do slightly out of the ordinary is
looked at suspiciously, jeered at or may even cause death.
LS instills a certain unhostile (if there exists such a word) approach to ur work by the
audience. The fact that some other gr8 person has already been working on a similar
problem gives a sense of security to the audience and tend to become more open to
understanding ur work. (NOTE: "Being open to understanding ur work" and
"Understanding ur work" r like "fish" and "bicycle". There is no relation b/w d two.)
For example, Consider a problem "Encryption scheme for mobile commerce". Even
non-IT ppl should get this as the basic principles of a LS are same irrespective of d
domain.
1. The 0th task (d one b4 the first task) is to properly understand what the
words/phrases "Encryption", "Encryption schemes", "mobile", "e-commerce",
"m-commerce" and its derivatives mean. U start up google and type
"encryption" and press enter. Lo and behold ur Literature Survey has begun.