summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/lwarp/lwarp_tutorial.txt
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/lwarp/lwarp_tutorial.txt')
-rw-r--r--macros/latex/contrib/lwarp/lwarp_tutorial.txt95
1 files changed, 95 insertions, 0 deletions
diff --git a/macros/latex/contrib/lwarp/lwarp_tutorial.txt b/macros/latex/contrib/lwarp/lwarp_tutorial.txt
new file mode 100644
index 0000000000..a3b5a70ec8
--- /dev/null
+++ b/macros/latex/contrib/lwarp/lwarp_tutorial.txt
@@ -0,0 +1,95 @@
+
+% Save this as tutorial.tex for the lwarp package tutorial.
+
+\documentclass{book}
+
+\usepackage{iftex}
+
+% --- LOAD FONT SELECTION AND ENCODING BEFORE LOADING LWARP ---
+
+\ifPDFTeX
+\usepackage{lmodern} % pdflatex or dvi latex
+\usepackage[T1]{fontenc}
+\usepackage[utf8]{inputenc}
+\else
+\usepackage{fontspec} % XeLaTeX or LuaLaTeX
+\fi
+
+% --- LWARP IS LOADED NEXT ---
+\usepackage[
+% HomeHTMLFilename=index, % Filename of the homepage.
+% HTMLFilename={node-}, % Filename prefix of other pages.
+% IndexLanguage=english, % Language for xindy index, glossary.
+% latexmk, % Use latexmk to compile.
+% OSWindows, % Force Windows. (Usually automatic.)
+% mathjax, % Use MathJax to display math.
+]{lwarp}
+% \boolfalse{FileSectionNames} % If false, numbers the files.
+
+% --- LOAD PDFLATEX MATH FONTS HERE ---
+
+% --- OTHER PACKAGES ARE LOADED AFTER LWARP ---
+\usepackage{makeidx} \makeindex
+\usepackage{xcolor} % (Demonstration purposes only.)
+\usepackage{hyperref,cleveref} % LOAD THESE LAST!
+
+% --- LATEX AND HTML CUSTOMIZATION ---
+\title{The Lwarp Tutorial}
+\author{Some Author}
+\setcounter{tocdepth}{2} % Include subsections in the \TOC.
+\setcounter{secnumdepth}{2} % Number down to subsections.
+\setcounter{FileDepth}{1} % Split \HTML\ files at sections
+\booltrue{CombineHigherDepths} % Combine parts/chapters/sections
+\setcounter{SideTOCDepth}{1} % Include subsections in the side\TOC
+\HTMLTitle{Webpage Title} % Overrides \title for the web page.
+\HTMLAuthor{Some Author} % Sets the HTML meta author tag.
+\HTMLLanguage{en-US} % Sets the HTML meta language.
+\HTMLDescription{A description.}% Sets the HTML meta description.
+\HTMLFirstPageTop{Name and \fbox{HOMEPAGE LOGO}}
+\HTMLPageTop{\fbox{LOGO}}
+\HTMLPageBottom{Contact Information and Copyright}
+\CSSFilename{lwarp_sagebrush.css}
+
+\begin{document}
+
+\maketitle % Or titlepage/titlingpage environment.
+
+% An article abstract would go here.
+
+\tableofcontents % MUST BE BEFORE THE FIRST SECTION BREAK!
+\listoffigures
+
+\chapter{First chapter}
+
+\section{A section}
+
+This is some text which is indexed.\index{Some text.}
+
+\subsection{A subsection}
+
+See \cref{fig:withtext}.
+
+\begin{figure}\begin{center}
+\fbox{\textcolor{blue!50!green}{Text in a figure.}}
+\caption{A figure with text\label{fig:withtext}}
+\end{center}\end{figure}
+
+\section{Some math}
+
+Inline math: $r = r_0 + vt - \frac{1}{2}at^2$
+followed by display math:
+\begin{equation}
+a^2 + b^2 = c^2
+\end{equation}
+
+
+\begin{warpprint} % For print output ...
+\cleardoublepage % ... a common method to place index entry into TOC.
+\phantomsection
+\addcontentsline{toc}{chapter}{\indexname}
+\end{warpprint}
+\ForceHTMLPage % HTML index will be on its own page.
+\ForceHTMLTOC % HTML index will have its own toc entry.
+\printindex
+
+\end{document}