Monday, October 17, 2011

Latex Project Report Template

Hi,

I have made an Unofficial BE Project Report Template in latex for Pune University - PICT College.

Note :
1) For BTech CSE NIT Calicut Template, & Bharati Vidyapeeth’s College of Engineering for Women, Pune University Latex Template, check the references below.

2) This template is for preliminary report. If you are looking for Final BE Project Report check this post.

To use it in an easy way, you can go to this site. It's an online latex web application. Although I did it on my Fedora KDE 15 Desktop, but many people don't have Linux or the software, so this will work no matter what OS you have as long as you have the net connection.

  1. Go to this site.
  2. Sign up for an Account by clicking on Sign up on top right.
  3. Choose Free account.
  4. Enter all details and ready your account.
  5. Once you are done, Select New Project
  6. Choose the name project
  7. Go to my Github repo here and download the repo as a zip file.
  8. Once you have downloaded the file.Go back to the Scribtex and click upload file.
  9. Select the file and select check box - This is a zip file and should be extracted
  10. Upload the file.
  11. Once uploaded, you will see a new folder being created with something like firesofmay-Latex-Template-XXXXX - rename that folder by hovering over it to project.
  12. Above is a very important step Since I have added the path as project/file.tex in all the files, hence the change is required.
  13. Go to settings of your project and in compiler settings enter project/report.  
  14. report.tex is the main file (like main function in a c program). So we are telling the web app this is the file to start with.
  15. Click save. Select Files, select project folder, you should see all the files being uploaded. It has one README file, one jpg (pict-logo.jpg) and a few tex files.


Now Modify the files as you need to for your report.
Few Notes :-

% is an equivalent to // in C i.e. % is a comment specifier till the end of line.

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

\\ is an equivalent to \n in C. Note at some places you can't add \n just like that.

Start with report.tex file
report.tex includes these files in this order
  1. title page - First Page- title.tex
  2. cover page - Second Page - cover.tex
  3. Index Page - Automatically Generated
  4. List of Figures - Automatically Generated
  5. Introduction page - Intro to your project - introduction.tex
  6. Literature Survey page - All your IEEE survey - literature-survey.tex
  7. Project Statement page - Problem Statement, Explanantion - project-statement.tex
  8. System Requirements page - Use Case, DFD, Activity Diagram - sys-req.tex
  9. Scheduling and Planning page - Your plans - planning.tex
  10. References page - Your References - ref.tex
You can modify and add anything anywhere you like in above files.

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

Once you are done, Either go to main project folder and select "View as PDF" or goto any file and click on compile. It will generate the PDF file for you.

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 when you do print preview, it is not printed with a highlighted view, so don't worry if you see that, else ignore this tip.

Please Read the Documentation of Latex here or 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.

I don't know many things in latex myself. So instead of asking me, Google it, Read The documentation, or ask at the #latex IRC channel, that's how I have been able to figure out my problems and create this template for you guys :).

Also, note that to add more pictures, upload the file and update the picture place holders.

Also if you see something like this:-
\fontsize{12.6468mm}{1mm} \textbf{Project Group No - <<Group Number Here>>}\\[2cm]

Here, <<>> is a place holder for you to remove and add your own content.

So if your group number is lets say 21, it will become

\fontsize{12.6468mm}{1mm} \textbf{Project Group No - 21}\\[2cm]


Note Remove the << and >> also!!!

You'll see <<Some text>> at many places in tex files.
I have added them for you to know here's a place to start modifying!!

\\[2cm] means give newline and the next line has a gap of 2cm.

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 on my github account

Hope it helps.
Enjoy :)

References :-
I have used this guy's template and modified it to suit Pune Universities Latex Template.Thanks Kartik :)

Update 2: Kartik added a link back to this post on his blog post :)

Update 3: Avani Shah of Bharati Vidyapeeth’s College of Engineering for Women, Pune University also made a Latex template which is tailor made for her college. Here's the link.

Note - I am not responsible if your guide does not accept your report for any reason. Please consult your Guide before you use this template ;)

7 comments:

Note: Only a member of this blog may post a comment.