lwarp (22feb17)

git-svn-id: svn://tug.org/texlive/trunk@43317 c570f23f-e606-0410-a88d-b1316a301751

3 files changed, 88 insertions, 7 deletions

diff --git a/Master/texmf-dist/doc/latex/lwarp/README.txt b/Master/texmf-dist/doc/latex/lwarp/README.txt
index e1fe2cc950a..7b7b21bb892 100644
--- a/Master/texmf-dist/doc/latex/lwarp/README.txt
+++ b/Master/texmf-dist/doc/latex/lwarp/README.txt
@@ -1,9 +1,10 @@
 
-LaTeX lwarp package v0.20   README.txt
+LaTeX lwarp package v0.21   README.txt
 
 Files included are:
 
 lwarp.pdf: The documentation.
+lwarp_tutorial.txt: More documentation.  A sample tutorial.
 lwarpmk.lua: A utility program which compiles print or HTML versions.
 lwarp.dtx: The documented source code.
 lwarp.ins: The documentaiton driver.
@@ -14,16 +15,19 @@ lwarp-newproject.sty: Locally generates configuration files per project.
 lwarp-*.sty: Numerous compatibility files for other packages.
 
 
-The documentation includes a file listing "tutorial.tex" which may be
-copy/pasted from the documentation into an editor.
-
-
-NOTE:
+NOTE FOR TEX DISTRIBUTION MAINTAINERS:
 For a TeX distribution, an executable called "lwarpmk" should
-be created which is a copy of or which calls the "lwarpmk.lua" script.
+be created in each bin directory, which is a link to or which
+calls the "lwarpmk.lua" script found in the scripts directory.
 See the installation instructions in the documentation.
 
 
+The documentation includes a file listing "tutorial.tex" which may be
+copied/pasted from the documentation into an editor, or it may
+be copied from the file lwarp_tutorial.tex, which is found in the
+documentation directory.
+
+
 License:
 This work may be distributed and/or modified under the
 conditions of the LaTeX Project Public License, either version 1.3
diff --git a/Master/texmf-dist/doc/latex/lwarp/lwarp.pdf b/Master/texmf-dist/doc/latex/lwarp/lwarp.pdf
index 7438ec468dc..a07837eea40 100644
--- a/Master/texmf-dist/doc/latex/lwarp/lwarp.pdf
+++ b/Master/texmf-dist/doc/latex/lwarp/lwarp.pdf
diff --git a/Master/texmf-dist/doc/latex/lwarp/lwarp_tutorial.txt b/Master/texmf-dist/doc/latex/lwarp/lwarp_tutorial.txt
new file mode 100644
index 00000000000..89da7124729
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/lwarp/lwarp_tutorial.txt
@@ -0,0 +1,77 @@
+
+% 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
+\usepackage[T1]{fontenc}
+\usepackage[utf8]{inputenc}
+\else
+\usepackage{fontspec}          % XeLaTeX or LuaLaTeX
+\fi
+
+% --- HTML FILENAME AND LATEXMK SETTINGS ---
+% \newcommand{\HomeHTMLFilename}{index} % Filename of the homepage.
+% \newcommand{\HTMLFileName}{node-} % Filename prefix of other pages.
+% \newcommand{\UseLatexmk}{true}% Uncomment to use latexmk
+
+% --- LWARP IS LOADED NEXT ---
+\usepackage{lwarp-newproject}   % Possibly with the [lwarpmk] option.
+\usepackage{lwarp}
+% \boolfalse{FileSectionNames}  % If false, numbers the files.
+
+% --- OTHER PACKAGES ARE LOADED AFTER LWARP ---
+\usepackage{makeidx} \makeindex
+\usepackage{xcolor}
+
+\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 sideTOC
+\SetFirstPageTop{Name and \fbox{HOMEPAGE LOGO}}
+\SetPageTop{\fbox{LOGO}}
+\SetPageBottom{Contact Information and Copyright}
+\NewCSS{lwarp_sagebrush.css}
+
+\begin{document}
+\maketitle                      % (or a titlepage environment)
+
+% --- An abstract may be placed here. ---
+
+\tableofcontents \listoffigures % --- MUST BE BEFORE THE FIRST SECTION.
+
+\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$
+\begin{equation}
+a^2 + b^2 = c^2
+\end{equation}
+
+\printindex
+
+\end{document}