diff options
Diffstat (limited to 'Latex/Latex3/latex_basics_and_structure_script.rst')
| -rw-r--r-- | Latex/Latex3/latex_basics_and_structure_script.rst | 187 |
1 files changed, 101 insertions, 86 deletions
diff --git a/Latex/Latex3/latex_basics_and_structure_script.rst b/Latex/Latex3/latex_basics_and_structure_script.rst index 09e8d2a..d1db08b 100644 --- a/Latex/Latex3/latex_basics_and_structure_script.rst +++ b/Latex/Latex3/latex_basics_and_structure_script.rst @@ -1,73 +1,74 @@ .. Objectives .. ---------- -.. By the end of this tutorial, you will be able to +.. At the end of this tutorial, you will be able to .. 1. Understand basic structure of a LaTeX document, its various document .. classes and loading packages that add new features to the LaTeX system. .. #. Create a LaTeX document with a title and an abstract. -.. #. Create numbered and non-numbered sections and subsections in a LaTeX +.. #. Create numbered and non-numbered sections and sub-sections in a LaTeX .. document. .. #. Create an appendix in a LaTeX document. -.. #. Create a table of content in a LaTeX document. +.. #. Create a 'table of contents' in a LaTeX document. .. Prerequisites .. ------------- -.. 1. latex_intro +.. 1. Introduction to LaTeX .. Author : Harish Badrinath < harish [at] fossee [dot] in > - Internal Reviewer : + Internal Reviewer : Kiran Isukapatla < kiran [at] fossee [dot] in > External Reviewer : Langauge Reviewer : - Checklist OK? : <put date stamp here, if OK> + Checklist OK? : 26-Feb-2012 Script ------ .. L1 -{{{ Show the first slide containing title, name of the production +{{{ Show the first slide containing the title, name of the production team along with the logo of MHRD }}} .. R1 -Hello friends and welcome to the tutorial titled "Basics of LaTeX and its +Hello friends and welcome to the tutorial on "Basics of LaTeX and its document structure". .. L2 -{{{ Show the objectives slide }}} +{{{ Show the "Objectives" slide }}} .. R2 -.. By the end of this tutorial, you will be able to +At the end of this tutorial, you will be able to -.. 1. Understand basic structure of a LaTeX document, its various document -.. classes and loading packages that add new features to the LaTeX system. -.. #. Create a LaTeX document with a title and an abstract. -.. #. Create numbered and non-numbered sections and subsections in a LaTeX -.. document. -.. #. Create an appendix in a LaTeX document. -.. #. Create a table of content in a LaTeX document. +1. Understand basic structure of a LaTeX document, its various document + classes and loading packages that add new features to the LaTeX system. +#. Create a LaTeX document with a title and an abstract. +#. Create numbered and non-numbered sections and subsections in a LaTeX + document. +#. Create an 'appendix' in a LaTeX document. +#. Create a table of content in a LaTeX document. .. L3 -{{{ Switch to the pre-requisite slide }}} +{{{ Show the "Pre-requisite" slide }}} .. R3 -Before beginning this tutorial,we would suggest having a working installation of -LaTeX and suggest you to complete the tutorial titled "Introduction to LaTeX". +Before beginning this tutorial, we would suggest having a working installation +of LaTeX and also complete the tutorial "Introduction to LaTeX". .. L4 +{{{ Show the "A Very Basic LaTeX document" slide }}} .. R4 We begin this tutorial with an example introduced in the previous tutorial. -The text in the document is illustrative and can be replaced replaced by a +The text in the document is illustrative and can be replaced by a single alpha-numeric character, for example. When done so, the resulting document could be described as the shortest possible LaTeX input document, that creates an output file. It consists of 3 LaTeX commands and one line/character @@ -86,33 +87,38 @@ The first line reads .. L5 +{{{ Show the "documentclass command" slide }}} .. R5 -which more generally can be written as +documentclass article, which more generally can be written as .. L6 +{{{ Show the "documentclass command ..." slide }}} .. R6 +documentclass parameters DocumentClass. Where documentclass is a LaTeX command. Parameters specify if you want to use a non default font size, for example. More specifically the parameters can be used to alter things like font size of the document, paper size, two sided or single sided printing, etc, for each class, that is supported by LaTeX. -The supported classes have a few differences, in how the content of the document is typeset. +The supported classes have a few differences, in how the content of the document +is typeset. .. L7 +{{{ Show the "documentclass command: A Closer look" slide }}} .. R7 We now look at a hypothetical documentclass command. The command being shown on the screen, instructs LaTeX to Create a new document of class report. The available classes are article, proc, -report, book, slides, letter. +report, book, slides and letter. 12 pt: sets the font size of main font. Other are relatively adjusted. 10pt is the default. a4paper: specifies the paper size @@ -121,59 +127,66 @@ with a square in the margin .. L8 +{{{ Show the "usepackage command" slide }}} .. R8 -This statement can be used optionally and is used to include packages, which are -used to extend the LaTeX's capabilities. There are a number of packages that are -included by default with LaTeX2 base distribution. You can use the texdoc -command for accessing package documentation. +The usepackage command is called with package name argument, prepended with +optional parameters. It is included optionally in a LaTeX document, to include +packages, which further extend the LaTeX's capabilities. There are a number of +packages that are included by default with LaTeX2 base distribution. You can use +the texdoc command for accessing package documentation. .. L9 -:: +{{{ Show the "Top Matter" slide }}} .. R9 We add the title, the author and the date to the document before the \begin{document} directive. We compile the document to see if the details -appear in the document, but they donot. +appear in the document, but they do not. .. L10 +{{{ Show the "Top Matter ..." slide }}} .. R10 The command \maketitle adds title, authors name and date to the output file. -Of these only the date is optional. If date command is specified, then the given -date is used else today's date is used. +Of these only the date is optional. The date command can be called with an +optional parameter. If the optional parameter is not provided, the date of +compilation of the LaTeX document is used. The parameter, if specified is used +to override this value. .. L11 +{{{ Show the "abstract command" slide }}} .. R11 -The abstract command is used to insert abstract of a document, into the output -file.Place it in the location, where you want your abstract to present in -the document. It is available for the document classes article and report, but -not book +The abstract command is used to insert the abstract of a document, into the +output file.Place it in the location, where you want your abstract to present +in the document. It is available for the document classes article and report, +but not for the book class. .. L12 - +{{{ Show the "Sectioning" slide }}} .. R12 Titles chapters and sections are used to help the user find his or her way through your work. The following commands are available in the article class: section, subsection, subsubsection, paragraph and sub paragraph. The default -behavior is to use numbered sections. We can use un-numbered sections appending -* to section command. If you want to split your document without influencing the -section or chapter numbering use the part command. - +behavior is to use numbered sections. We can use un-numbered sections by +appending * to section command. If you want to split your document without +influencing the section or chapter numbering, use the part command. .. L13 +{{{ Show the "Creating Chapters" slide }}} + .. R13 Longer documents can use report or book class. We can add a new chapter using @@ -182,42 +195,42 @@ file shown in the slide we notice that subsections are not numbered. .. L14 +{{{ Show the "Sectioning and numbering" slide }}} .. R14 -We can change this behavior with the command setcounter , calling it as shown -in the slide. +We can change this behavior with the setcounter command, calling it with +parameters shown on the slide. .. L15 +{{{ Show the "Appendix" slide }}} .. R15 -Appendix can be added to the document using \appendix command. any content after -\appendix will be added to the appendix. In the report or book class, we have to -use \chapter to indicate that the chapters are to be numbered as appendices. +Appendix can be added to the document using \appendix command. Any content +after the \appendix command will be added to the appendix. In the report or +book class, we have to use \chapter command to indicate that the chapters are +to be numbered as appendices. -similarly for the article class we have to use the section command to indicate -that sections are to be numbered as appendices. +Similarly for the article class, we have to use the \section command to indicate +the sections that are to be numbered as appendices. .. L16 +{{{ Show the "Table of Contents [TOC]" slide }}} .. R16 -Lets add a Table of content to the document. The LaTeX command to add a TOC to a -document is using \tableofcontents command and is placed at the point at which -the table of content is to be placed. - -Now, compile the document and look at the output document. It does not have the table of contents! - -We compile our LaTeX file as usual. On the first compilation only the "Contents" -heading appears in the document, but the actual table does not appear. You will -need to compile your document once more, for the actual table to appear in your -document. On the first run, LaTeX has gone through your document and generated -a temporary file (.toc), with the entries that should go into the table of -contents. These entries are made, when you compile your document for the second -time. +We use the \tableofcontents command to add a TOC to a document is and is placed +at the point at which the table of content is to be placed. It must be noted +that \tableofcontents command requires the LaTeX input file to be compiled +twice. On the first compilation only the "Contents" heading appears in the +document, but the actual table does not appear. LaTeX has now gone through +the input document and generated a temporary file (.toc), with the entries that +should go into the table of contents. When the input document is compiled for +the second time, these entries are made and the actual table will appear in +your output document. Note that any section/block that has been numbered automatically appears in the table of contents. It is possible to get un-numbered sections, for instance a @@ -225,22 +238,23 @@ Preface or a Foreword section to appear in the Table of Contents. .. L17 +{{{ Show the "TOC ..." slide }}} .. R17 Un-numbered sections are added to TOC using \addcontentsline command. -For example we use the command -\addcontentsline{toc}{section}{Intro} -where "Intro" is the text that you want to appear in the Table of contents. +For example we use the addcontentsline command called with the parameters +"{toc}{section}{Intro}", for the text "Intro" to appear in the Table of +contents. .. L18 -{{{ Show slide with exercise 1 }}} +{{{ Show the "Exercise 1" slide }}} .. R18 -Write a LaTeX script that creates a document of type article, which contains both -a table of content and an appendix. The table of content should be at the +Write a LaTeX script that creates a document of type article, which contains +an appendix and a table of contents. The table of content should be at the beginning of the document and the appendix at the end. The book should contain two chapters, with the first chapter containing two @@ -252,7 +266,7 @@ Please pause the tutorial and check back for a possible solution .. L19 {{{continue from paused state}}} -{{{ Show slide with solution to exercise 1 }}} +{{{ Show the "Excercise 1: Solution" slide }}} .. R19 @@ -260,24 +274,24 @@ This slide on screen shows a possible valid solution to the given exercise. .. L20 -{{{ Show summary slide }}} +{{{ Show the "Summary" slide }}} .. R20 This brings us to the end of this tutorial. In this tutorial, we have, -.. 1. Gained an understanding of the basic structure of a LaTeX document, its -.. various document classes and loading packages that add new features to -.. the LaTeX system. -.. #. Created a LaTeX document with a title and an abstract. -.. #. Created both numbered and non-numbered sections and subsections in a -.. LaTeX document. -.. #. Created an appendix in a LaTeX document. -.. #. Created a table of content in a LaTeX document. +1. Gained an understanding of the basic structure of a LaTeX document, its + various document classes and loading packages that add new features to + the LaTeX system. +#. Created a LaTeX document with a title and an abstract. +#. Created both numbered and non-numbered sections and subsections in a + LaTeX document. +#. Created an appendix in a LaTeX document. +#. Created a table of content in a LaTeX document. .. L21 -{{{Show self assessment questions slide}}} +{{{ Show the "Self assessment questions" slide }}} .. R21 @@ -287,28 +301,29 @@ Here are some self assessment questions for you to solve and produces the intended result, that is to produce a book with two chapters and an appendix. - 2. subsection command can be placed at any arbitrary level. If they get numbered -by default using the appropriate setcounter command and secnumdepth parameter, -do they automatically appear in the table of content ?? + 2. subsection command can be placed at any arbitrary level. If they get +numbered by default using the appropriate setcounter command and secnumdepth +parameter, do they automatically appear in the table of content ?? .. L22 -{{{Show self assessment questions slide}}} +{{{ Show the "Solutions" slide }}} .. R22 And the answers, -1. Although the given file looks syntactically valid, the output file is not what -we expected. This is mainly because we are trying to use the section command to -create sections in the appendix, for a document whose type is given as a book. +1. Although the given file looks syntactically valid, the output file is not +what we expected. This is mainly because we are trying to use the section +command to create sections in the appendix, for a document whose type is given +as a book. 2. No, the \tableofcontents command normally shows only numbered section headings, and only down to the level defined by the tocdepth counter. .. L23 -{{{ Show the thankyou slide }}} +{{{ Show the "Thank you" slide }}} .. R23 |