Commit c78a9414 authored by Chris Cantwell's avatar Chris Cantwell

Fix some errors in documentation.

parent aed43873
......@@ -24,7 +24,7 @@ There are two ways to obtain the source code for \nekpp:
public repository. Use this initially if you would like to try using
Nektar++.
\begin{lstlisting}[style=BashInputStyle]
git clone http://gitlab.nektar.info/clone/nektar.git nektar++
git clone http://gitlab.nektar.info/clone/nektar/nektar.git nektar++
\end{lstlisting}
\item Using authenticated access. This will allow you to directly contribute
back into the code.
......@@ -95,7 +95,7 @@ Open a terminal.
If you have downloaded the tarball, first unpack it:
\begin{lstlisting}[style=BashInputStyle]
tar -zxvf nektar++-\nekver.tar.gz
tar -zxvf nektar++-(*\nekver*).tar.gz
\end{lstlisting}
Change into the \inlsh{nektar++} source code directory
\begin{lstlisting}[style=BashInputStyle]
......@@ -109,7 +109,7 @@ From a terminal:
\begin{enumerate}
\item If you have downloaded the tarball, first unpack it
\begin{lstlisting}[style=BashInputStyle]
tar -zxvf nektar++-\nekver.tar.gz
tar -zxvf nektar++-(*\nekver*).tar.gz
\end{lstlisting}
\item Change into the source-code directory, create a \inltt{build}
......@@ -118,7 +118,7 @@ From a terminal:
mkdir -p build && cd build
\end{lstlisting}
\item Run the CMake GUI and configure the build
\item Run the CMake GUI and configure the build by pressing \inltt{c}
\begin{lstlisting}[style=BashInputStyle]
ccmake ../
\end{lstlisting}
......@@ -264,7 +264,7 @@ Open a terminal (Applications->Utilities->Terminal).
If you have downloaded the tarball, first unpack it:
\begin{lstlisting}[style=BashInputStyle]
tar -zxvf nektar++-\nekver.tar.gz
tar -zxvf nektar++-(*\nekver*).tar.gz
\end{lstlisting}
Change into the \inlsh{nektar++} source code directory
\begin{lstlisting}[style=BashInputStyle]
......@@ -278,7 +278,7 @@ From a terminal (Applications->Utilities->Terminal):
\begin{enumerate}
\item If you have downloaded the tarball, first unpack it
\begin{lstlisting}[style=BashInputStyle]
tar -zxvf nektar++-\nekver.tar.gz
tar -zxvf nektar++-(*\nekver*).tar.gz
\end{lstlisting}
\item Change into the source-code directory, create a \inltt{build}
......
......@@ -149,7 +149,7 @@ openany, % A chapter may start on either a recto or verso page.
% Nektar++ version
\usepackage{xspace}
\newcommand{\nekver}{\input{../../VERSION}\xspace}
\newcommand{\nekver} {\input{../../VERSION}\unskip}
\newcommand{\p}{\partial} %Partial
% Or what ever you want
......@@ -211,7 +211,9 @@ openany, % A chapter may start on either a recto or verso page.
xleftmargin=0.05\linewidth,
keepspaces=true
}
\lstset{%
escapeinside={(*}{*)},%
}
\usepackage{tikz}
\newcommand{\inltt}[1]{\tikz[anchor=base,baseline]\node[inner sep=3pt,
rounded corners,outer sep=0,draw=black!30,fill=black!05]{\small\texttt{#1}};}
......
......@@ -278,7 +278,7 @@ We can manually specify this mapping by adding a colon to the
\begin{lstlisting}[style=XMLStyle]
<FUNCTION NAME="AdvectionVelocity">
<F VAR="Vx,Vy,Vz" VALUE="file.fld:u,v,w" />
<F VAR="Vx,Vy,Vz" FILE="file.fld:u,v,w" />
</FUNCTION>
\end{lstlisting}
......@@ -289,13 +289,13 @@ There are some caveats with this syntax:
after the colon. For example, the following is not valid.
\begin{lstlisting}[style=XMLStyle,gobble=4]
<FUNCTION NAME="AdvectionVelocity">
<F VAR="Vx,Vy,Vz" VALUE="file.fld:u" />
<F VAR="Vx,Vy,Vz" FILE="file.fld:u" />
</FUNCTION>\end{lstlisting}
\item This syntax is not valid with the wildcard operator \inltt{*}, so one
cannot write for example:
\begin{lstlisting}[style=XMLStyle,gobble=4]
<FUNCTION NAME="AdvectionVelocity">
<F VAR="*" VALUE="file.fld:u,v,w" />
<F VAR="*" FILE="file.fld:u,v,w" />
</FUNCTION>
\end{lstlisting}
\end{itemize}
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment