Wednesday 19 October 2011

Project Report Template in Latex

Hi friends,

LaTeX Template* (BVCOEW, Pune University)

This week, was spent in preparing my first project report in college and first using LaTeX. It took me over a few days to finish the work. (Am still doing some minor changes every now n then even today).  But the final output is quite impressive! :)) Had been recommended of using four softwares! And that was really very tedious, esp. for adding images.

But then, I found this, and this, helped me a lot in reducing my work! :)
Well, to use it in an easy way, you can go to this (an online latex web application) site.
And then,

  1. First, download the template here.
  2. Go to this site and Sign up for a free account.
  3. Once you are done, Select New Project and choose a name for your project.
  4. Click upload file.
  5. Select the file and tick the check box. (This is a zip file and should be extracted)
  6. And Upload the file.
  7. After uploading, a new folder gets created with something like iam-tas-Latex; rename that folder by hovering over it, to project.
  8. This is a very important step, since the path added is, as project/file.tex in all the files, hence the change is required.
  9. Go to settings of your project and in the compiler settings, enter project/report.
  10. report.tex is the main file. (Here, we tell the web app this is the file to start with.)
  11. Save.
  12. Select Files, select project folder, you will see all the files being uploaded. (It has one ReadMe file, one jpg (bvlogo.jpg) and a few tex files)
Now you can make your report with your stuff easily by just modifying the respective .tex file! :)

[Note:
I have added comments to make it easy to understand what is going on.

·        % => comments in Latex (as // in C)
·        \\ => newline (as \n in C)
·        \\[2cm] means give newline and the next line has a gap of 2cm.
·        Remove the << and >> also. (You'll see <<Some text>> at many places in tex files) 
·        Also, \fontsize{12.6468mm}{1mm} \textbf{Project Group No - <<Group Number Here>>}\\[2cm] implies, here, <<>> is a place holder for you to remove and add your own content.]

Next,

Start with report.tex file. This file includes the other files in the following order:
1. Title page - First Page- title.tex
2. Cover page - Second Page - cover.tex
3. Certificate – Third Page – certificate.tex
4. Acknowledgements- acknowledgement.tex
5. Abstract- abstract.tex
6. Index Page – (Automatically Generated)
7. List of Figures - (Automatically Generated)
8. List of Tables - (Automatically Generated)
9. Introduction page - Intro to your project - introduction.tex
10. Literature Survey page - All your IEEE survey - literature-survey.tex
11. Project Statement page - Problem Statement, Explanation - project-statement.tex
12. System Requirements page - Use Case, DFD, Activity Diagram - sys-req.tex
13. Scheduling and planning page - Your plans - planning.tex
14. References page - Your References - ref.tex

report.tex does not need any modification. But read it to get an idea of what is put for the report and in what order and all. Once done reading report.tex, start with files in the above order and modify them and save them according to your stuff and continue with the next file.

Once you are done, either click Compile or go to main project folder and select "View as PDF". This generates the PDF file! Iterate over your work, and your latex report should be ready in no time! :)

[Note: It generates a clickable Table of contents and list of figures, references which is highlighted sometimes, but in the print preview, you can see, the highlighted view is not printed. So, don’t worry on seeing those highlights! This refers to the References too!]

For more information, you can download the book from here. It's a free book by wiki community.

Major part of the latex has been done in this template, but every project has its own requirement, so modify as it suits you.

To add more pictures, upload the file and update the picture place holders.

Use the documentation to search for exactly what you need.

NOTE FOR THOSE WHO ARE USING THIS TEMPLATE OFFLINE:

Also, if you are going to use this inside a desktop environment let's say Linux and use the latex tool on your OS instead of this site, you have to update all the paths specified from project/file to file.

If something needs to be fixed, please let me know by leaving a message at be.avanishah@gmail.com

All the Best! :)
Enjoy! And Hope this helps! :)




References: I have used this template and modified it, to suit our college’s LaTeX Template! :) Thank You Mayank ! :)

I am also very grateful to him for the constant encouragement as well as helping me out in finally starting with a blog of my own! :)

And here is the Original Template for the LaTeX Project Report by Kartik!



*I am not responsible if your guide/ college do not accept your report for any reason.  Please consult your Guide before you using this template! :)

5 comments:

  1. Great post!! You made the template really well.

    Ill add your post back in my post as references
    and will ask kartik to do the same.

    kudos! keep posting more awesome stuff!!

    ReplyDelete
  2. Thanks avni for suggesting a goog method for latex

    ReplyDelete
  3. Thanks avni for suggesting such a helpful method

    ReplyDelete
  4. @firesofmay, hehe Thanks to you! :)

    yeah definitely! :)

    ReplyDelete
  5. @Madhavi, :) arre Anytime! :)
    Enjoy! :)

    ReplyDelete