diff options
| -rw-r--r-- | Latex/latex_intro_script.rst | 240 | ||||
| -rw-r--r-- | Version_Control/vcs1/vcs1.rst | 51 |
2 files changed, 265 insertions, 26 deletions
diff --git a/Latex/latex_intro_script.rst b/Latex/latex_intro_script.rst new file mode 100644 index 0000000..331fa15 --- /dev/null +++ b/Latex/latex_intro_script.rst @@ -0,0 +1,240 @@ +.. Objectives +.. ---------- + +.. By the end of this tutorial, you will be able to + +.. 1. Become familiar with the history of, development of LaTeX. +.. #. Description of a typical work flow, when using LaTeX to typeset documents. +.. #. Advantages and disadvantages of typesetting documents using +.. the LaTeX approach. +.. #. Create a very simple LaTeX document + +.. Prerequisites +.. ------------- + +.. 1. Should have already installed LaTeX and its supported packages on the host machine. +.. #. Should be comfortable using a text editor of choice. + + +.. Author : Harish Badrinath < harish [at] fossee [dot] in > + Internal Reviewer : + External Reviewer : + Langauge Reviewer : + Checklist OK? : <put date stamp here, if OK> + +Script +------ + +.. L1 + +{{{ Show the first slide containing title, name of the production +team along with the logo of MHRD }}} + +.. R1 + +Hello Friends and Welcome to the tutorial on introduction to LaTeX. + +.. L2 + +{{{ Show the objectives slide }}} + +.. R2 + +At the end of this tutorial, you will be able to, + + 1. Have an insight on the history and development of LaTeX. + #. Adopt a simple work flow, that uses LaTeX to typset documents. + #. Know about the Advantages and disadvantages of typesetting documents using +.. the LaTeX approach. + #. Will have gone through an example on creating a very simple LaTeX document. + +.. L3 + +{{{ Switch to the pre-requisite slide }}} + +.. R3 + +Before beginning this tutorial,we would suggest having a working installation of +LaTeX on your computer. You can do this by completing the tutorial titled +"Installing LaTeX". + +.. L4 + +{{{ switch to the photograph of Donald E. Knuth }}} + +.. R4 + +LaTeX began as TeX, a computer program originally created by +Donald E. Knuth. Its was designed mainly to aid typesetting +of text and mathematical formulae. TeX was started to reverse +the trend of deteriorating typographical quality of the then, +nascent digital publishing industry. + +LaTeX is a document preparation system for high quality type +setting. It is based on the TeX typesetting language or certain +extensions. + +.. L5 + +{{{ switch to pronunciation stock photograph }}} + +.. R5 + +LaTeX is pronounced Lah-tech or Lay-tec. +TeX is pronounced Tech. TeX is also the first syllable in the greek word for +technology. +LaTeX allows authors to typeset and print their content at the highest +typographical quality, using predefined, professional layouts. + +.. L6 + +{{{ switch to Image saying/symbolizing work flow }}} + +.. R6 +LaTeX input files are simple ASCII text files that are processed by a TeX +processing engine. +Next comes the question compiling LaTeX input files and viewing the output +typeset document. +The process is a little different from other markup languages like HTML. +We compile ASCII text files into typeset files that are normally DVI,Postscript +or PDF files. +The latex command converts LaTeX input files into dvi files. +We can view DVI files on Gnu/Linux using xdvi. +Further DVI files can be converted either to a post script file, using the +dvips command or to a PDF file using the dvipdfm command. +The command pdflatex is used to convert LaTeX input files directly to pdf files. +The resultant PDF files can be viewed using standard tools on most platforms +(Eg: evince on Gnu/Linux). PDF file are also widely supported. + +.. L7 + +{{{ switch to stock photograph of/symbolizing advantages and disadvantages }}} + +.. R7 + +Some of the advantages of using LaTeX approach to typesetting are +(1) Easy availability of professionally crafted layouts. +(2) Typesetting of mathematical formulae is supported in a convenient +environment. +(3) Typesetting for most cases can be done with very little learning curve +using easy to use/understand commands, that only specify the logical structure +of the document. +(4) Presence of lots of add-on packages. +(5) It encourages creation of well structured texts. + +.. L8 + +{{{ switch to stock photograph of/symbolizing advantages and disadvantages }}} + +.. R8 + +Some of the disadvantages of using LaTeX approach to typesetting are +(1) Designing a whole new layout is difficult. +(2) Typesetting even complex documents, is done using mostly text editors. + +.. L9 +:: + +{{{ Show slide with exercise 1 }}} +\documentclass{article} +\title{My First LaTeX Document} +\author{Harish} +\begin{document} +\maketitle +Hello world! +\end{document} + +.. R9 + +Now, we try to create a simple LaTeX document. Pause the tutorial and type the +content shown on the screen in a text editor. Save the file as temp.tex + +.. L10 + +{{{continue from paused state}}} +latex temp.tex + +.. R10 + +Now we compile the commands in the LaTeX input file that is, temp.tex into a +typeset file. +The first alternative is to compile LaTeX input file into a DVI file. We use +the latex command for this purpose. +For compiling the LaTeX input file temp.tex into a DVI file, we use the +following command +latex temp.tex. +The output file would be temp.dvi. +On Gnu/Linux use a program like xdvi to view the output file. + +.. L11 + +pdflatex temp.tex + +.. R11 + +The other alternative is to create PDF files from LaTeX input files. +We use the pdflatex command for this purpose. +For compiling the LaTeX input file temp.tex into a PDF file, we use the +following command +pdflatex temp.tex +The output file would be temp.pdf +On Gnu/Linux use a program like evince to view the output file. + +.. L12 + +{{{ Show summary slide }}} + +.. R12 + +This brings us to the end of this tutorial. In this tutorial, we have, + + 1. An insight on the history and development of LaTeX. + #. Adopted a simple work flow, that uses LaTeX to typeset documents. + #. Come to Know the Advantages and disadvantages of typesetting documents +.. using the LaTeX approach. + #. Have gone through an example on creating a very simple LaTeX document. + +.. L13 + +{{{Show self assessment questions slide}}} + +.. R13 + +Here are some self assessment questions for you to solve + + 1. Convert the temp.dvi created during the course of this tutorial to temp_1.ps +using the dvips command. Verify that the two files indeed look the same. + + 2. Convert the temp.dvi created during the course of this tutorial to +temp_1.pdf using the dvipdfm command. Verify that the two files indeed look the +same. + +3. Remove the line "\maketitle" from temp.tex file. Recompile the file into +either a DVI or a PDF file. what is the difference between the original output +and the output from the newer version of the temp.tex file ?? + +.. L14 + +{{{Show self assessment questions slide}}} + +.. R14 + +And the answers, + +1. We can use the following command to convert temp.dvi to temp_1.ps +dvips -o temp_1.ps temp.dvi + +2. We can use the following command to convert temp.dvi to temp_1.pdf +dvipdfm -o temp_1.pdf temp.dvi + +3. The output file consists of a file with a single line of text "Hello world!". + +.. L15 + +{{{ Show the thank you slide }}} + +.. R15 + +Hope you have enjoyed this tutorial and found it useful. +Thank you! + diff --git a/Version_Control/vcs1/vcs1.rst b/Version_Control/vcs1/vcs1.rst index 3121ee3..863ed87 100644 --- a/Version_Control/vcs1/vcs1.rst +++ b/Version_Control/vcs1/vcs1.rst @@ -5,8 +5,8 @@ .. None .. Author : Primal Pappachan - Internal Reviewer : - Date: Sept 23, 2011 + Internal Reviewer : Kiran Isukapatla + Date: Jan 8, 2012 -------- Script -------- @@ -29,11 +29,11 @@ At the end of this tutorial you will be able to 1. Understand what is Version Control and the need for it. -#. Create and use repository on a daily basis +#. Create and use a repository on a daily basis. .. R3 -First let's understand what Version Control is +First, let's understand what 'Version Control' is. .. L3 @@ -41,9 +41,8 @@ First let's understand what Version Control is .. R4 -Version control is just a way to track your files over time and share them. This allows you to go back to older versions when something goes wrong, see what changed when and why, collaborate on a single piece of work with a bunch of people. - -Version control is just a way of backing up your files, before making changes to it. Most people would have cooked up their own version control system, without realizing there are tools built by others which takes the task much more organized and systematic. +'Version control' is a way to track files over time and share them. This allows access to earlier versions of a file(s) if and when required. It therefore enables us to make changes to the content of a file, view it's change log and collaborate on a single piece of work with a team of people. + .. L4 @@ -53,17 +52,17 @@ Version control is just a way of backing up your files, before making changes to Let's look at an example of home-brew Version Control system -Version control is just a way of backing up your files, before making changes to it. Most people would have cooked up their own version control system, without realizing there are tools built by others which takes the task much more organized and systematic. +Version control is a way of backing up files, before making changes. Most people would have cooked up their own version control system, without realizing, there were tools built by others, that performs the task in a more organized and systematic way. .. L5 {{{Show the slide 'Problems'}}} -Let's look at the various problems associated with this setup. +Let's look at the various problems associated with this set-up. .. R6 -Now let's move onto identifying the needs for a Version Control System. +Now, let's move to identifying the needs for a 'Version Control System'. .. L6 @@ -71,13 +70,13 @@ Now let's move onto identifying the needs for a Version Control System. .. R7 -We have seen that one of the main motivation to use a version system control system is the ability to go back to a working version of the file, when something stops working. Below are a few more advantages of using an automated version control system. +We have seen that one of the main motivations to use a Version Control system is the ability to go back to a working version of a file, when something goes wrong. Below are a few more advantages of using an automated version control system. -1. By tracking the history of the project, an outsider can see the evolution of a project. +1. By tracking the history of a project, any person may see the evolution of a project. -#. Allows for effective collaboration on the project as everything is shared. +#. Allows for effective collaboration on a project, as everything is shared. -#. Helps to identify which additions have broken down the project and thus aids in efficient tracking down of the bugs. +#. Helps to identify which additions have broken down a project and thus aids in efficient tracking down of the bugs. #. It is good for a one man show as it is for a big group of people working on a project. @@ -88,7 +87,7 @@ We have seen that one of the main motivation to use a version system control sys .. R8 -It is, in some ways, similar to playing a video game. We generally play games in stages, saving the game, each time we finish a stage or complete a task. We continue playing, but we could, if necessary, choose to go back to one of the saved states and start over. In this manner we could change the state of the game. +It is, in some ways, similar to playing a video game. We generally play games in stages. While playing, we save the game at some instances as per our choice. We continue playing, but we could, if necessary, choose to go back to one of the saved states and start over. In this manner, we could change the state of the game. .. L8 @@ -96,10 +95,10 @@ It is, in some ways, similar to playing a video game. We generally play games in .. R9 -Some of the Version Control tool available and used widely are: +Some of the Version Control tools available and used widely are: 1. cvs(Concurrent Version Systems) - + #. svn(subversion) #. hg(mercurial) @@ -108,7 +107,7 @@ Some of the Version Control tool available and used widely are: .. R10 -Each of these tools have their own merits and demerits. In this tutorial we will be learning to use mercurial or hg. +Each of these tools have their own merits and demerits. In this tutorial we shall learn how to use mercurial or hg. Let's now get into Installation @@ -140,7 +139,7 @@ $hg version .. R13 -Now why exactly is a repo? A repo/repository is a folder with all your files and a store of all the changes that were made to it. To save disk space, hg doesn't save all files, but only saves only a series of changes made to the files. +Now, what exactly is a repo? A repo/repository is a folder with contains all the files and information on all the changes that were made to it. To save disk space, hg doesn't save all files, but only saves only a series of changes made to the files. .. L13 @@ -148,7 +147,7 @@ Now why exactly is a repo? A repo/repository is a folder with all your files and .. R14 -Let's now see how to initialize a repo +Let's now see how to initialize a repo. .. L14 @@ -186,7 +185,7 @@ hg help status .. R17 -Have a look at what various status codes associated with files means. By looking at the codes, it is clear that our files are not yet being tracked by hg. Now Let's move onto Adding Files. +Have a look at what various status codes, associated with the files mean. By looking at the codes, it is clear that our files are not being tracked by hg yet. Now let's move onto 'Adding Files'. .. L16 @@ -194,7 +193,7 @@ $hg status .. R18 -This shows that none of the files in the folder have not been added yet. +This shows that none of the files in the folder have been added yet. .. L17 @@ -202,7 +201,7 @@ $hg add .. R19 -This simply adds all the files in the (working) directory, to the repository, As expected, the status command shows an A has been appeneded to the filenames. We could also specify files individually, for example +This simply adds all the files in the (working) directory, to the repository. As expected, the status command shows an 'A' has been appended to the filenames. We could also specify files individually, for example .. L18 @@ -226,7 +225,7 @@ $ hg st .. R21 -To see the history of changes made to our repository, we use hg log. We can view the change that we just made to our repoistory. +To see the history of changes made to our repository, we use hg log. We can view the change that we just made to our repository. .. L21 @@ -239,7 +238,7 @@ hg log gives the log of the changes made in the form of changesets. A changeset .. R22 -User information is set in the hgrc file. It can be either globally or locally to the project. +User information is set in the hgrc file. It can be either set globally or locally to the project. For linux systems .. L23 @@ -253,7 +252,7 @@ editor = vim .. R23 -We have now set the username details for mercurial to use. +We have now set the user-name details for mercurial to use. .. L24 |