iskm/learnxinyminutes-docs
1
0
Fork 0
mirror of https://github.com/adambard/learnxinyminutes-docs.git synced 2025-04-27 15:43:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add Hyperlinks description (#2370)

Browse Source 
Also add small changes in style:
- LaTeX -> \LaTeX
- improve alignment for formulas in Math section

Add table of contents
This commit is contained in:
Strange Storyteller 2016-09-27 18:41:45 +04:00 committed by ven
parent acd1ac4611
commit 8fa91ffcb2
1 changed files with 63 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
latex.html.markdown
View File

@ -5,6 +5,7 @@ contributors:
- ["Colton Kohnke", "http://github.com/voltnor"] - ["Colton Kohnke", "http://github.com/voltnor"]
- ["Sricharan Chiruvolu", "http://sricharan.xyz"] - ["Sricharan Chiruvolu", "http://sricharan.xyz"]
- ["Ramanan Balakrishnan", "https://github.com/ramananbalakrishnan"] - ["Ramanan Balakrishnan", "https://github.com/ramananbalakrishnan"]
- ["Svetlana Golubeva", "https://attillax.github.io/"]
filename: learn-latex.tex filename: learn-latex.tex
--- ---
@ -27,14 +28,17 @@ filename: learn-latex.tex
% If you want to include graphics, colored text, or % If you want to include graphics, colored text, or
% source code from another language file into your document, % source code from another language file into your document,
% you need to enhance the capabilities of LaTeX. This is done by adding packages. % you need to enhance the capabilities of LaTeX. This is done by adding packages.
% I'm going to include the float and caption packages for figures. % I'm going to include the float and caption packages for figures
% and hyperref package for hyperlinks
\usepackage{caption} \usepackage{caption}
\usepackage{float} \usepackage{float}
\usepackage{hyperref}
% We can define some other document properties too! % We can define some other document properties too!
\author{Chaitanya Krishna Ande, Colton Kohnke \& Sricharan Chiruvolu} \author{Chaitanya Krishna Ande, Colton Kohnke, Sricharan Chiruvolu \& \\
Svetlana Golubeva}
\date{\today} \date{\today}
\title{Learn LaTeX in Y Minutes!} \title{Learn \LaTeX \hspace{1pt} in Y Minutes!}
% Now we're ready to begin the document % Now we're ready to begin the document
% Everything before this line is called "The Preamble" % Everything before this line is called "The Preamble"
@ -43,18 +47,28 @@ filename: learn-latex.tex
% create a title page for us. % create a title page for us.
\maketitle \maketitle
% If we have sections, we can create table of contents. We have to compile our
% document twice to make it appear in right order.
% It is a good practice to separate the table of contents form the body of the
% document. To do so we use \newpage command
\newpage
\tableofcontents
\newpage
% Most research papers have abstract, you can use the predefined commands for this. % Most research papers have abstract, you can use the predefined commands for this.
% This should appear in its logical order, therefore, after the top matter, % This should appear in its logical order, therefore, after the top matter,
% but before the main sections of the body. % but before the main sections of the body.
% This command is available in the document classes article and report. % This command is available in the document classes article and report.
\begin{abstract} \begin{abstract}
LaTeX documentation written as LaTeX! How novel and totally not my idea! \LaTeX \hspace{1pt} documentation written as \LaTeX! How novel and totally not
my idea!
\end{abstract} \end{abstract}
% Section commands are intuitive. % Section commands are intuitive.
% All the titles of the sections are added automatically to the table of contents. % All the titles of the sections are added automatically to the table of contents.
\section{Introduction} \section{Introduction}
Hello, my name is Colton and together we're going to explore LaTeX! Hello, my name is Colton and together we're going to explore \LaTeX!
\section{Another section} \section{Another section}
This is the text for another section. I think it needs a subsection. This is the text for another section. I think it needs a subsection.
@ -72,12 +86,14 @@ Much better now.
However not all sections have to be numbered! However not all sections have to be numbered!
\section{Some Text notes} \section{Some Text notes}
LaTeX is generally pretty good about placing text where it should go. If %\section{Spacing} % Need to add more information about space intervals
a line \\ needs \\ to \\ break \\ you add \textbackslash\textbackslash to \LaTeX \hspace{1pt} is generally pretty good about placing text where it should
the source code. \\ go. If
a line \\ needs \\ to \\ break \\ you add \textbackslash\textbackslash
\hspace{1pt} to the source code. \\
\section{Lists} \section{Lists}
Lists are one of the easiest things to create in LaTeX! I need to go shopping Lists are one of the easiest things to create in \LaTeX! I need to go shopping
tomorrow, so let's make a grocery list. tomorrow, so let's make a grocery list.
\begin{enumerate} % This creates an "enumerate" environment. \begin{enumerate} % This creates an "enumerate" environment.
% \item tells the enumerate to increment % \item tells the enumerate to increment
@ -93,8 +109,8 @@ tomorrow, so let's make a grocery list.
\section{Math} \section{Math}
One of the primary uses for LaTeX is to produce academic articles or One of the primary uses for \LaTeX \hspace{1pt} is to produce academic articles
technical papers. Usually in the realm of math and science. As such, or technical papers. Usually in the realm of math and science. As such,
we need to be able to add special symbols to our paper! \\ we need to be able to add special symbols to our paper! \\
Math has many symbols, far beyond what you can find on a keyboard; Math has many symbols, far beyond what you can find on a keyboard;
@ -112,25 +128,25 @@ Here's how you state all y that belong to X, $\forall$ x $\in$ X. \\
\[a^2 + b^2 = c^2 \] \[a^2 + b^2 = c^2 \]
My favorite Greek letter is $\xi$. I also like $\beta$, $\gamma$ and $\sigma$. My favorite Greek letter is $\xi$. I also like $\beta$, $\gamma$ and $\sigma$.
I haven't found a Greek letter that yet that LaTeX doesn't know about! I haven't found a Greek letter that yet that \LaTeX \hspace{1pt} doesn't know
about! \\
Operators are essential parts of a mathematical document: Operators are essential parts of a mathematical document:
trigonometric functions ($\sin$, $\cos$, $\tan$), trigonometric functions ($\sin$, $\cos$, $\tan$),
logarithms and exponentials ($\log$, $\exp$), logarithms and exponentials ($\log$, $\exp$),
limits ($\lim$), etc. limits ($\lim$), etc.
have per-defined LaTeX commands. have per-defined LaTeX commands.
Let's write an equation to see how it's done: \\ Let's write an equation to see how it's done:
$\cos(2\theta) = \cos^{2}(\theta) - \sin^{2}(\theta)$ \\
$\cos(2\theta) = \cos^{2}(\theta) - \sin^{2}(\theta)$ Fractions (Numerator-denominators) can be written in these forms:
Fractions(Numerator-denominators) can be written in these forms:
% 10 / 7 % 10 / 7
$^{10}/_{7}$ $$ ^{10}/_{7} $$
% Relatively complex fractions can be written as % Relatively complex fractions can be written as
% \frac{numerator}{denominator} % \frac{numerator}{denominator}
$\frac{n!}{k!(n - k)!}$ \\ $$ \frac{n!}{k!(n - k)!} $$ \\
We can also insert equations in an "equation environment". We can also insert equations in an "equation environment".
@ -185,12 +201,10 @@ We can also insert Tables in the same way as figures.
\end{tabular} \end{tabular}
\end{table} \end{table}
% \section{Hyperlinks} % Coming soon \section{Getting \LaTeX \hspace{1pt} to not compile something (i.e. Source Code)}
Let's say we want to include some code into our \LaTeX \hspace{1pt} document,
\section{Getting LaTeX to not compile something (i.e. Source Code)} we would then need \LaTeX \hspace{1pt} to not try and interpret that text and
Let's say we want to include some code into our LaTeX document, instead just print it to the document. We do this with a verbatim
we would then need LaTeX to not try and interpret that text and
instead just print it to the document. We do this we a verbatim
environment. environment.
% There are other packages that exist (i.e. minty, lstlisting, etc.) % There are other packages that exist (i.e. minty, lstlisting, etc.)
@ -204,26 +218,43 @@ environment.
\section{Compiling} \section{Compiling}
By now you're probably wondering how to compile this fabulous document By now you're probably wondering how to compile this fabulous document
and look at the glorious glory that is a LaTeX pdf. and look at the glorious glory that is a \LaTeX \hspace{1pt} pdf.
(yes, this document actually does compile). \\ (yes, this document actually does compile). \\
Getting to the final document using LaTeX consists of the following steps: Getting to the final document using \LaTeX \hspace{1pt} consists of the following
steps:
\begin{enumerate} \begin{enumerate}
\item Write the document in plain text (the "source code"). \item Write the document in plain text (the "source code").
\item Compile source code to produce a pdf. \item Compile source code to produce a pdf.
The compilation step looks something like this (in Linux): \\ The compilation step looks like this (in Linux): \\
\begin{verbatim} \begin{verbatim}
> pdflatex learn-latex.tex learn-latex.pdf > pdflatex learn-latex.tex
\end{verbatim} \end{verbatim}
\end{enumerate} \end{enumerate}
A number of LaTeX editors combine both Step 1 and Step 2 in the same piece of A number of \LaTeX \hspace{1pt}editors combine both Step 1 and Step 2 in the
software. So, you get to see Step 1, but not Step 2 completely. same piece of software. So, you get to see Step 1, but not Step 2 completely.
Step 2 is still happening behind the scenes. Step 2 is still happening behind the scenes.
You write all your formatting information in plain text in Step 1. You write all your formatting information in plain text in Step 1.
The compilation part in Step 2 takes care of producing the document in the The compilation part in Step 2 takes care of producing the document in the
format you defined in Step 1. format you defined in Step 1.
\section{Hyperlinks}
We can also insert hyperlinks in our document. To do so we need to include the
package hyperref into preamble with the command:
\begin{verbatim}
\usepackage{hyperref}
\end{verbatim}
There exists two main types of links: visible URL \\
\url{https://learnxinyminutes.com/docs/latex/}, or
\href{https://learnxinyminutes.com/docs/latex/}{shadowed by text}
% You can not add extra-spaces or special symbols into shadowing text since it
% will cause mistakes during the compilation
This package also produces list of tumbnails in the output pdf document and
active links in the table of contents.
\section{End} \section{End}
That's all for now! That's all for now!
@ -233,7 +264,8 @@ That's all for now!
\begin{thebibliography}{1} \begin{thebibliography}{1}
% similar to other lists, the \bibitem command can be used to list items % similar to other lists, the \bibitem command can be used to list items
% each entry can then be cited directly in the body of the text % each entry can then be cited directly in the body of the text
\bibitem{latexwiki} The amazing LaTeX wikibook: {\em https://en.wikibooks.org/wiki/LaTeX} \bibitem{latexwiki} The amazing \LaTeX \hspace{1pt} wikibook: {\em
https://en.wikibooks.org/wiki/LaTeX}
\bibitem{latextutorial} An actual tutorial: {\em http://www.latex-tutorial.com} \bibitem{latextutorial} An actual tutorial: {\em http://www.latex-tutorial.com}
\end{thebibliography} \end{thebibliography}