Pages

Thursday, May 1, 2014

Report writing with LyX / LaTeX

Hi ,

In this post I will be sharing about how to prepare a Project Report using Lyx and Latex.

In most if the Engineering Colleges , Professors asks Final Project report to be written in Latex .

First , What is Latex ?
LaTeX is a document preparation system for high-quality typesetting. It is most often used for medium-to-large technical or scientific documents but it can be used for almost any form of publishing.

Why Latex..?
LaTeX is not a word processor! Instead, LaTeX encourages authors not to worry too much about the appearance of their documents but to concentrate on getting the right content.

LaTeX is usually pronounced /ˈleɪtɛk/ or /ˈlɑːtɛk/ in English (that is, not with the /ks/ pronunciation English speakers normally associate with X, but with a /k/   ex: Letech).

 For more  visit LaTeX Website .

With this brief introduction lets move on to LyX now.

Why LyX when you have LaTeX..?
    LaTeX is for passionate Linux people who are more interested  in coding rather than  using GUI's which are available . Since many of you don't want to learn LaTeX coding because of different reasons like time constraints, laziness,  not interested in learning something new just for sake of doing one report, you have something for you.. that's LyX.

So what is LyX all about..?
LyX combines the power and flexibility of TeX/LaTeX with the ease of use of a graphical interface. This results in world-class support for creation of mathematical content (via a fully integrated equation editor) and structured documents like academic articles, theses, and books. In addition, staples of scientific authoring such as reference list and index creation come standard. But you can also use LyX to create a letter or a novel or a theatre play or film script. A broad array of ready, well-designed document layouts are built in.

For more visit LyX website or a Brief Tutorial.

With all this background lets Start writing a report in LyX.

For that first you need to install LyX in your system. Here is the link  to download : LyX download. Please install the latest version for your respective operating system.

It might also ask you to install the compiler, MikTeX , If it doesn't automatically asks you to install, please install from this link.

After installing Launch  LyX application in your system,

For all the small things you can refer help available in the application menu bar.It is better then most of the tutorials available on web to solve your specific issues. It's better to go through the tutorial available there before starting working, it is descriptive and gives in depth knowledge and confidence to write report.

For writing a report more than 10 pages its better to divide it into smaller parts and then include it in a main configuration file so that if we run into any trouble we can make suitable changes to that small file. Make sure that the Number of pages in the small file doesn't exceed  5 or 6 pages.
You can divide into small files  based on different chapters or subheading or based on your convenience.

On launching You will go to welcome screen, now we shall make some basic settings to start our Report writing project.

1. Go to File in menu bar, select new (or Ctrl + N ).
2. Click on Document in menu bar --> Settings, a Document setting popup will come.
3. In the Setting popup click on "Document Class", On the main area next to scroll bar, Click on the dropdown and select report . It gives more option for report writing and your report looks like a professional one.
4. If you are using any mathematical formulae or equation then select appropriate option in the "Modules" .
5. In "Page Layout" change the Format to "A4" or your appropriate choice.
6. In "Page Margin" Change according to standard set by your university.
7. Make appropriate changes in other option if you wish, or leave it to default values.
8. "LaTeX Preamble" is the area where you enter LaTeX commands, that need to be run before loading your page, more on that will be coming next.

Now go ahead with writing your report, for sure you must have a draft report ready with you and you should be knowing how many chapters your report contains, as suggested earlier make that many files you feel comfortable and include all in the one configuration file, which acts as your control file.

For the better understanding of how to write a report I have attached a template file here.
Download LyX template. or here

This file serves as basic project report from which you can make your own report. This contains self explanatory tips which are to be used while composing.

Few of the features included in the above template are listed below:

  • One main configuration File named report.lyx which contains basic instruction and includes all the files the report should comprise of.
  • Roman page numbering for introduction pages, Arabic numbers for description pages.
  • Header and Footer which are editable by going into Latex preamble in settings.
  • Title page which can be modified to respective project.
  • A sample Certificate page.
  • A cover and index page.
  • Auto generated Table of content, List of Figures and Tables used in the project.
  • Few of sample chapter pages and information about what to write in those.
  • An Appendix file .
After going through the report , which is self explanatory if you find any problem feel free to contact me at remeberElecronics@gmail.com

Also for LaTeX Enthusiastics a LaTeX Template is also found here.
Download LaTeX Report template.



Thanks for reading..
Happy report writing :)







No comments:

Post a Comment