new doc latex-doc-ptr (6apr09)

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

9 files changed, 383 insertions, 1 deletions

diff --git a/Master/texmf-doc/doc/english/latex-doc-ptr/Makefile b/Master/texmf-doc/doc/english/latex-doc-ptr/Makefile
new file mode 100644
index 00000000000..3c72b22cce0
--- /dev/null
+++ b/Master/texmf-doc/doc/english/latex-doc-ptr/Makefile
@@ -0,0 +1,2 @@
+latex-doc-ptr.pdf: latex-doc-ptr.tex latex-doc-ptr.sty
+	pdflatex --file-line-error --interaction=nonstopmode $<
diff --git a/Master/texmf-doc/doc/english/latex-doc-ptr/README b/Master/texmf-doc/doc/english/latex-doc-ptr/README
new file mode 100644
index 00000000000..a8ce73b93c0
--- /dev/null
+++ b/Master/texmf-doc/doc/english/latex-doc-ptr/README
@@ -0,0 +1,23 @@
+latex-doc-ptr
+
+This is intended as the document that comes up when a person runs 
+'texdoc latex'.  The idea is that an exhaustive reference for LaTeX
+is not what the overwhelming majority of users would find useful at
+that point.  So instead, in addition to naming such a reference,
+it points to a selection of docs that may be of value to a variety
+of users.
+
+ToDo:
+  1) Would like to recommend a tutorial that would have a person go from 
+no installed software to a first document, good-looking, containing some
+math, in an afternoon. 
+
+License: 
+  public domain
+
+Comments to:
+  Jim Hefferon  email ftpmaint at tug.ctan.org
+
+History:
+  2009-Mar-24 Jim Hefferon, Manuel Pégourié-Gonnard, Karl Berry
+
diff --git a/Master/texmf-doc/doc/english/latex-doc-ptr/latex-doc-ptr.pdf b/Master/texmf-doc/doc/english/latex-doc-ptr/latex-doc-ptr.pdf
new file mode 100644
index 00000000000..f0719a1c1b1
--- /dev/null
+++ b/Master/texmf-doc/doc/english/latex-doc-ptr/latex-doc-ptr.pdf
diff --git a/Master/texmf-doc/doc/english/latex-doc-ptr/latex-doc-ptr.sty b/Master/texmf-doc/doc/english/latex-doc-ptr/latex-doc-ptr.sty
new file mode 100644
index 00000000000..097cfce6023
--- /dev/null
+++ b/Master/texmf-doc/doc/english/latex-doc-ptr/latex-doc-ptr.sty
@@ -0,0 +1,93 @@
+% latex-doc-ptr.sty  style for LaTeX doc pointer document  
+% Jim Hefferon  public domain
+\usepackage[margin=1in]{geometry}
+
+\usepackage{color,graphicx}
+
+%\usepackage{dash}
+\usepackage{url}
+
+\usepackage{hyperref}
+\hypersetup{colorlinks,breaklinks,
+            linkcolor=black,citecolor=blue,
+            filecolor=blue,urlcolor=blue,
+            pdfpagemode=UseNone}
+\usepackage{tgbonum}
+
+\usepackage[para]{footmisc}
+% Change horiz room between fn mark and fn hskip from .5em 
+% Suggested to RF making this settable
+\long\def\@makefntext#1{\leavevmode
+\@makefnmark\nobreak
+\hskip.05em\relax#1%
+}
+
+\newcommand{\texdoc}[1]{\/\footnote{\protect\texttt{#1}}}
+
+
+\setlength{\parskip}{-.25ex plus -.05ex minus -.05ex}
+% \@startsection {NAME}{LEVEL}{INDENT}{BEFORESKIP}{AFTERSKIP}{STYLE} 
+%            optional * [ALTHEADING]{HEADING}
+%    Generic command to start a section.  
+%    NAME       : e.g., 'subsection'
+%    LEVEL      : a number, denoting depth of section -- e.g., chapter=1,
+%                 section = 2, etc.  A section number will be printed if
+%                 and only if LEVEL < or = the value of the secnumdepth
+%                 counter.
+%    INDENT     : Indentation of heading from left margin
+%    BEFORESKIP : Absolute value = skip to leave above the heading.  
+%                 If negative, then paragraph indent of text following 
+%                 heading is suppressed.
+%    AFTERSKIP  : if positive, then skip to leave below heading,
+%                       else - skip to leave to right of run-in heading.
+%    STYLE      : commands to set style
+%  If '*' missing, then increments the counter.  If it is present, then
+%  there should be no [ALTHEADING] argument.  A sectioning command
+%  is normally defined to \@startsection + its first six arguments.
+
+% \makeatletter
+\def\section{\@startsection {section}{1}{\z@}{-3ex plus -.45ex minus 
+    -.20ex}{4.75ex plus .45ex minus .20ex}{\centering\Large\bf}}
+\def\subsection{\@startsection {subsection}{2}{\z@}{-2.5ex plus -.15ex minus 
+    -.10ex}{.80ex plus .1ex}{\centering\large\bf}}
+\def\subsubsection{\@startsection{subsubsection}{3}{\z@}{-.85ex plus -.15ex minus 
+   -.05ex}{-.75em}{\normalsize\sc}}
+% \makeatother
+\setcounter{secnumdepth}{0} % Number the sections only if level -1 or less 
+\setlength{\parskip}{.85ex plus .15ex minus .05ex}
+
+\pagestyle{empty}
+
+\newcommand{\program}[1]{\texttt{#1}}
+\newcommand{\package}[1]{\textit{#1}}
+% Used for backslash
+\newcommand\SLASH{\char`\\}
+% Last thing before the document: define the \XeTeX logo (stolen from
+% TUGboat).  This requires reflecting the first E, hence we complain if
+% the graphics package is not present.  (For plain documents, this can
+% be loaded via Eplain.)  Also, at Barbara's suggestion, if the current
+% font is slanted, we rotate by 180 instead of reflecting so there is at
+% least a chance to look ok.
+% 
+%    \begin{macrocode}
+\def\tubreflect#1{%
+  \ifx\reflectbox\relax
+    \errmessage{A graphics package must be loaded for \string\XeTeX}%
+  \else
+    \ifdim \fontdimen1\font>0pt
+      \raise 1.35ex \hbox{\kern.1em\rotatebox{180}{#1}}\kern-.1em
+    \else
+      \reflectbox{#1}%
+    \fi
+  \fi
+}
+\def\tubhideheight#1{\setbox0=\hbox{#1}\ht0=0pt \dp0=0pt \box0 }
+\DeclareRobustCommand\Xe[1]{\leavevmode
+  \tubhideheight{\hbox{X%
+    \setbox0=\hbox{\TeX}\setbox1=\hbox{E}%
+    \lower\dp0\hbox{\raise\dp1\hbox{\kern-.125em\tubreflect{E}}}%
+    \kern-.1667em #1}}}
+\newcommand{\xetex}{\Xe\TeX}
+\newcommand{\pdftex}{pdf\TeX}
+\newcommand{\luatex}{Lua\TeX}
+\newcommand{\texworks}{\TeX{}works}
diff --git a/Master/texmf-doc/doc/english/latex-doc-ptr/latex-doc-ptr.tex b/Master/texmf-doc/doc/english/latex-doc-ptr/latex-doc-ptr.tex
new file mode 100644
index 00000000000..5a85185beed
--- /dev/null
+++ b/Master/texmf-doc/doc/english/latex-doc-ptr/latex-doc-ptr.tex
@@ -0,0 +1,259 @@
+\documentclass[10pt]{article}
+\usepackage{latex-doc-ptr}
+
+% This document is intended as the result of a "texdoc latex" in TeX Live.  
+% The license is Public Domain.  See README file for more.
+
+\begin{document}\thispagestyle{empty}
+\section{\LaTeX}
+
+\LaTeX{} is the most popular macro package for \TeX{}.
+(A macro package is a set of commands that an author typically uses
+to write documents.) 
+ 
+This page does not try to answer all questions about \LaTeX; 
+rather  
+we suggest some documentation, add-on components, and resources
+that a \LaTeX{} user can start with.
+We limit our recommendations to freely-available materials,
+and you can click on the text to see the documentation on the Internet.
+(In case the Internet is not convenient, when the documentation is also 
+available
+in a typical \TeX{} installation we provide its name in a footnote;
+to view it locally using 
+\href{http://tug.org/texdoc}{\package{texdoc}},\texdoc{texdoc}
+run ``\texttt{texdoc \textit{name}}'' at a command prompt.)
+
+
+
+
+\subsection{Starting out}
+
+The article
+\href{http://tug.org/pracjourn/2005-1/waud/waud.pdf}
+ {\texttt{\SLASH begin\{here\} \% getting started}}
+gives a thorough description aimed at a complete beginner.
+In particular, to use \LaTeX{}, users must install a \TeX{} distribution, 
+such as 
+MiK\TeX{} on Windows, or  
+\TeX{}~Live on
+a Unix system such as GNU/Linux or on Windows,
+or Mac\TeX{} on Macintosh OS~X.
+
+Online tutorials have been created by
+\href{http://www.andy-roberts.net/misc/latex/}{\package{Andy Roberts}}
+and the
+\href{http://tug.org/tutorials/tugindia/}{\package{TUGIndia user group}}.
+
+
+
+
+\subsection{Documentation}
+
+\subsubsection{Essentials}
+The most widely-recommended introduction is 
+\href{http://mirror.ctan.org/info/lshort/}
+ {\package{The Not-So Short Guide to \LaTeXe}}.\texdoc{lshort}
+For typesetting mathematics, use the
+the American Mathematical Society's  
+AMS-\LaTeX{} package, 
+introduced in the primer,
+\href{http://mirror.ctan.org/info/amslatex/primer/amshelp.pdf}
+ {\package{Getting up and running with AMS-\LaTeX}}.\texdoc{amshelp}
+
+
+\subsubsection{References}  
+The official \LaTeX{} documentation from the development team 
+is 
+\href{http://mirror.ctan.org/macros/latex/doc/usrguide.pdf}
+ {\package{\LaTeXe{} for Authors}};\texdoc{usrguide} this focuses on
+changes made in recent versions of \LaTeX{}.
+The nearest thing to a general reference manual for \LaTeX{} is the unofficial
+\href{http://mirror.ctan.org/info/latex2e-help-texinfo/latex2e.html}
+ {\package{\LaTeX: Structured documents for \TeX}}.\texdoc{latex2e}
+Look for symbols in the
+\href{http://mirror.ctan.org/info/symbols/comprehensive/symbols-letter.pdf}
+ {\package{Comprehensive List of Symbols}}.\texdoc{comprehensive}
+A two-page
+\href{http://mirror.ctan.org/info/latexcheat/latexsheet.pdf}
+ {\package{\LaTeX{} Cheat Sheet}}\texdoc{latexcheat} is available.
+The document 
+\href{http://mirror.ctan.org/info/l2tabu/}
+ {\textit{l2tabu}}\texdoc{l2tabuen}
+can help you to acquire sound habits by
+suggesting what you should consider taboo.
+
+
+\subsubsection{FAQ's}
+Many web pages offer help with \TeX{} and \LaTeX{}.
+Particularly useful is the
+\href{http://www.tex.ac.uk/faq}{\package{English FAQ}}\texdoc{faq} 
+and the 
+\href{http://tug.org/interest.html}{\package{TUG web resources page}}.
+The \href{http://tug.org/pracjourn/}{\package{Prac\TeX{} Journal}}
+is an online magazine aimed at beginning and intermediate users, and
+\href{http://tug.org/TUGboat/}{\package{TUGboat}}
+has published many articles at all levels nearly since the inception of 
+\TeX{}.
+
+\subsubsection{Books}
+There are many books about \LaTeX{}; 
+visit the 
+\href{http://tug.org/books/}
+ {\package{\TeX{} Users Group Bookstore}} for discounts.
+
+
+
+\subsection{Selected \LaTeX{} packages}
+
+\subsubsection{Page size and shape}
+Adjust the page dimensions 
+and orientation with  
+\href{http://mirror.ctan.org/macros/latex/contrib/geometry/geometry.pdf}
+ {\package{geometry}}.\texdoc{geometry}
+Control headers and footers with 
+\href{http://mirror.ctan.org/macros/latex/contrib/fancyhdr/fancyhdr.pdf}
+ {\package{fancyhdr}}.\texdoc{fancyhdr}
+
+\subsubsection{Graphics}
+Import graphics into a \LaTeX{} document with the \LaTeX{} team's  
+\href{http://mirror.ctan.org/macros/latex/required/graphics/}
+ {\package{graphicx}} package, and the related \textit{graphics}.
+The official documentation is  
+\href{http://mirror.ctan.org/macros/latex/required/graphics/grfguide.pdf}
+ {\package{Packages in the `graphics' bundle}}.\texdoc{grfguide}
+Another package in the same bundle is \package{color}.\texdoc{color}
+For even more color capability use
+\href{http://mirror.ctan.org/macros/latex/contrib/xcolor/xcolor.pdf}
+ {\package{xcolor}}.\texdoc{xcolor}
+An excellent introduction to using these is the article
+\href{http://tug.org/pracjourn/2005-3/hoeppner/hoeppner.pdf}
+ {\package{Strategies for including graphics in \LaTeX{} documents}}. 
+% not free: 
+% \href{http://www.ctan.org/tex-archive/info/epslatex/}{\textit{Using Imported Graphics in \LaTeX{} and pdf\LaTeX{}}}.
+
+
+\subsubsection{Index and bibliography}
+Make an index with \href{http://mirror.ctan.org/macros/latex/base/makeindx.dtx}
+ {\package{makeidx}}.\texdoc{makeindex}
+For bibliographies, people use 
+\href{http://en.wikipedia.org/wiki/BibTeX}{\package{B{\footnotesize IB}\TeX{}}}.\texdoc{bibtex}
+Two powerful tools based on it are: produce your bibliography
+in a natural science styles with 
+\href{http://mirror.ctan.org/macros/latex/contrib/natbib/natbib.pdf}
+ {\package{natbib}},\texdoc{natbib}
+and generate your own style by answering a sequence of questions with 
+\href{http://mirror.ctan.org/macros/latex/contrib/custom-bib/makebst.pdf}
+ {\package{custom-bib}}.\texdoc{custom-bib}
+
+\subsubsection{Computer code and commenting out}
+For computer code, look at
+\href{http://mirror.ctan.org/macros/latex/contrib/listings/listings.pdf}
+ {\package{listings}}.\texdoc{listings}
+The 
+\href{http://mirror.ctan.org/macros/latex/required/tools/verbatim.pdf}
+ {\package{verbatim}}\texdoc{verbatim}
+package is also useful for computer code, and 
+includes a \texttt{comment} environment to suppress parts of the document.
+
+\subsubsection{Hypertext}
+The 
+\href{http://mirror.ctan.org/macros/latex/contrib/hyperref/hyperref.pdf}
+ {\package{hyperref}}\texdoc{hyperref}
+package gives you 
+hyper-document features, such as making table of contents 
+entries link to the corresponding document part.
+If you don't need active links, typeset web addresses with 
+\href{http://mirror.ctan.org/macros/latex/contrib/misc/url.sty}
+  {\package{url}},\texdoc{url}
+which also does computer file names.
+
+\subsubsection{Presentations}
+You can get presentation slides by
+adjusting the page geometry and writing a regular document.
+For more sophisticated effects use
+\href
+ {http://mirror.ctan.org/macros/latex/contrib/beamer/doc/beameruserguide.pdf}
+ {\package{beamer}}.\texdoc{beamer}
+The article
+\href{http://tug.org/pracjourn/2005-4/mertz/mertz.pdf}
+  {\package{Beamer by example}} will get you started.
+
+
+
+\subsection{Output and fonts}
+
+\subsubsection{Output}
+The 
+\href{http://tug.org/applications/pdftex/}{\package{pdf\TeX}}\texdoc{pdftex}
+program extends \TeX{}:
+it can directly produce web-friendly PDF files, as well as the
+traditional DVI format.
+For instance,  this document was generated under \TeX{}~Live with 
+\verb!pdflatex latex_doc_ptr.tex!.
+A further extension to that, 
+\href{http://en.wikipedia.org/wiki/XeTeX}{\package{\xetex}},\texdoc{xetex}
+can use fonts from your underlying computer platform,
+in addition to the fonts from your \TeX{} distribution.
+(Mathematics requires much special tuning, though, so most
+system fonts cannot be used for math.)
+
+
+\subsubsection{Fonts}
+The font system documentation from the \LaTeX{} developers is 
+\href{http://mirror.ctan.org/macros/latex/doc/fntguide.pdf}
+ {\package{\LaTeXe{} font selection}}.\texdoc{fntguide}
+To move beyond \TeX's default fonts, these two
+documents describe some reasonable and free alternatives:
+\href{http://mirror.ctan.org/info/Free_Math_Font_Survey/en/survey.html}
+ {\package{A Survey of Free Math Fonts for \TeX{} and \LaTeX{}}}
+and 
+\href{http://www.tug.dk/FontCatalogue/}{\package{The \LaTeX{} Font Catalogue}}.
+More is on the 
+\href{http://tug.org/fonts/}{\TeX{} Users Group's font page}.
+
+
+
+\subsection{Tools for composing \LaTeX{}}
+
+There are many environments to make writing \LaTeX{} source easier.
+For instance, many people use a text editor of some sort, such as 
+Emacs with the add-on mode 
+\href{http://www.gnu.org/software/auctex/}{\package{AUC-\TeX{}}}.
+A new environment that is free, runs on all major 
+computer platforms, and combines the best ideas 
+from available environments while retaining simplicity, is 
+\href{http://tug.org/texworks/}{\texworks}.
+
+
+\subsection{Community}
+
+There are many
+\href{http://tug.org/usergroups.html}{user groups}
+for \TeX{}.
+The 
+\href{http://www.ctan.org/}{Comprehensive \TeX{} Archive Network}
+contains many more packages than any distribution.
+In addition, if you are stuck on an issue, the Usenet group
+\href{http://groups.google.com/group/comp.text.tex}{\texttt{comp.text.tex}} 
+and 
+\href{http://lists.tug.org/texhax}{\texttt{texhax@tug.org}} 
+are the most popular mailing lists. 
+You can search more than a decade of 
+\LaTeX{} discussions, or post a question yourself.
+
+
+\subsection{Miscellaneous}
+
+\subsubsection{History}
+\LaTeX{} was first written in 1985 by Leslie Lamport, building on 
+Donald Knuth's \TeX{}.
+It is now maintained and developed by the 
+\href{http://www.latex-project.org}{\LaTeX{}3 Project}\texdoc{latex3} group.
+
+\subsubsection{Pronunciation}
+\LaTeX{} can be pronounced as
+``la-tech'' or ``lay-tech,'' with emphasis on either syllable.
+(We prefer the first, with emphasis on the first syllable.)
+
+\end{document}
diff --git a/Master/tlpkg/bin/tlpkg-ctan-check b/Master/tlpkg/bin/tlpkg-ctan-check
index ef6bd0e3cbf..1e01f0df8a5 100755
--- a/Master/tlpkg/bin/tlpkg-ctan-check
+++ b/Master/tlpkg/bin/tlpkg-ctan-check
@@ -127,7 +127,7 @@ my @WorkingTLP = qw(
         kalender kastrup kerkis kerntest keystroke knuth koma-script kpfonts
         l2picfaq l2tabu-english l2tabu-it l2tabu-spanish
           labbook labelcas labels lastpage
-          latex latex2e-help-texinfo latex2man
+          latex latex-doc-ptr latex2e-help-texinfo latex2man
           latex-course latex-tds latexcheat latexmk latexmp
           layouts lcd lcg lcyw leading leaflet ledmac leftidx lettrine
           lewis lfb lgreek lh
diff --git a/Master/tlpkg/libexec/ctan2tds b/Master/tlpkg/libexec/ctan2tds
index ce67097753a..37f82960e3e 100755
--- a/Master/tlpkg/libexec/ctan2tds
+++ b/Master/tlpkg/libexec/ctan2tds
@@ -582,6 +582,7 @@ $standardsource='\.fdd|\.dtx|\.ins|\.c$|Makefile|configure.*|install-sh|\.drv';
  'fpl',			'Add|\.sfd|\.pe|\.ps' . $standardsource,
  'impatient',		'NULL',	# doc package
  'intro-scientific',	'NULL',	# doc package
+ 'latex-doc-ptr',	'NULL',	# doc package
  'latex2e-help-texinfo','NULL',	# doc package
  'latex2man',		'NULL',	# leave Makefile
  'mpman-ru',		'NULL',	# doc package
@@ -846,6 +847,7 @@ $standardtex='\.(cfg|sty|clo|ldf|cls|def|fd|cmap|4ht)$';
  'keystroke',	'keystroke_.*|\.sty',
  'kuvio',	'\.tex|\.sty',
  'latex-course','NULL',  # keep doc together
+ 'latex-doc-ptr',	'NULL',  # keep doc together
  'lettre',	'\.ins|\.cls',
  'magyar',	'NULL',  # do not install in runtime, conflicts with babel
  'manjutex',	'\.sty|\.clo|\.ldf|\.cls|\.def|\.fd$|manju.tex',
diff --git a/Master/tlpkg/tlpsrc/collection-documentation-english.tlpsrc b/Master/tlpkg/tlpsrc/collection-documentation-english.tlpsrc
index e129e8d20d2..b69ab9d72aa 100644
--- a/Master/tlpkg/tlpsrc/collection-documentation-english.tlpsrc
+++ b/Master/tlpkg/tlpsrc/collection-documentation-english.tlpsrc
@@ -20,6 +20,7 @@ depend knuth
 depend l2tabu-english
 depend latex2e-help-texinfo
 depend latex-course
+depend latex-doc-ptr
 depend latex-graphics-companion
 depend latex-web-companion
 depend latexcheat
diff --git a/Master/tlpkg/tlpsrc/latex-doc-ptr.tlpsrc b/Master/tlpkg/tlpsrc/latex-doc-ptr.tlpsrc
new file mode 100644
index 00000000000..26c896d973d
--- /dev/null
+++ b/Master/tlpkg/tlpsrc/latex-doc-ptr.tlpsrc
@@ -0,0 +1,2 @@
+name latex-doc-ptr
+category Documentation