From f9cdf6d0869e9672668bf7e5f523c80aa7ea44b1 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Wed, 2 Feb 2011 01:06:44 +0000 Subject: morehype (1feb11) git-svn-id: svn://tug.org/texlive/trunk@21256 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/source/latex/morehype/README.tex | 11 ++ Master/texmf-dist/source/latex/morehype/blog.tex | 125 +++++++++++++++++++++ Master/texmf-dist/source/latex/morehype/gather.tex | 6 + .../texmf-dist/source/latex/morehype/hypertoc.tex | 79 +++++++++++++ .../texmf-dist/source/latex/morehype/makedoc.cfg | 40 +++++++ .../texmf-dist/source/latex/morehype/mdoccorr.cfg | 51 +++++++++ .../texmf-dist/source/latex/morehype/texlinks.tex | 66 +++++++++++ 7 files changed, 378 insertions(+) create mode 100644 Master/texmf-dist/source/latex/morehype/README.tex create mode 100644 Master/texmf-dist/source/latex/morehype/blog.tex create mode 100644 Master/texmf-dist/source/latex/morehype/gather.tex create mode 100644 Master/texmf-dist/source/latex/morehype/hypertoc.tex create mode 100644 Master/texmf-dist/source/latex/morehype/makedoc.cfg create mode 100644 Master/texmf-dist/source/latex/morehype/mdoccorr.cfg create mode 100644 Master/texmf-dist/source/latex/morehype/texlinks.tex (limited to 'Master/texmf-dist/source/latex/morehype') diff --git a/Master/texmf-dist/source/latex/morehype/README.tex b/Master/texmf-dist/source/latex/morehype/README.tex new file mode 100644 index 00000000000..ce26748edb5 --- /dev/null +++ b/Master/texmf-dist/source/latex/morehype/README.tex @@ -0,0 +1,11 @@ +\ProvidesFile{README.tex}[2010/11/27 make README.pdf] +\listfiles + +\documentclass[12pt]{article} +\usepackage{verbatim} +\pagestyle{empty} +\begin{document} +\vspace*{-2\baselineskip} +\enlargethispage{1\baselineskip} +\verbatiminput{README.txt} +\end{document} diff --git a/Master/texmf-dist/source/latex/morehype/blog.tex b/Master/texmf-dist/source/latex/morehype/blog.tex new file mode 100644 index 00000000000..cf46597d225 --- /dev/null +++ b/Master/texmf-dist/source/latex/morehype/blog.tex @@ -0,0 +1,125 @@ +\ProvidesFile{blog.tex}[2011/01/27 documenting blog.sty] +\title{\textsf{blog.sty}\\---\\% + Generating HTML Quickly with \TeX\thanks{This + document describes version + \textcolor{blue}{\UseVersionOf{\jobname.sty}} + of \textsf{\jobname.sty} as of \UseDateOf{\jobname.sty}.}} +% \listfiles +{ \RequirePackage{makedoc} \ProcessLineMessage{} + \renewcommand\mdSectionLevelOne{\string\subsection} + \renewcommand\mdSectionLevelTwo{\string\subsubsection} + \MakeJobDoc{17}{\SectionLevelTwoParseInput} } +\documentclass{article}%% TODO paper dimensions!? +\input{makedoc.cfg} %% shared formatting settings +\ReadPackageInfos{blog} +\usepackage{color} + %% \tagcode seems to be a quite recent pdfTeX primitive, + %% cf. microtype.pdf ... %% 2010/11/06 +\newcommand*{\xmltagcode}[1]{\texttt{<#1>}} +\sloppy +\begin{document} +\maketitle +\begin{abstract}\noindent +'blog.sty' provides \TeX\ macros for generating web pages, +based on processing text files using the 'fifinddo' package. +Some \LaTeX\ +commands %%% command names +are redefined to access their HTML +equivalents, other new macro names ``quote" the names of +HTML elements. The package has evolved in several little steps +each aiming at getting pretty-looking ``hypertext" \textbf{notes} +with little effort, +where ``little effort" also has meant avoiding studying +documentation of similar packages already existing. +[TODO: list them!] +% Version v0.3 is the remainder of v0.2 after moving some stuff +% to 'fifinddo.sty' (especially `\CopyFile'); +% moreover, the new `\BlogCopyFile' replaces empty source lines +% by HTML's \xmltagcode{p} (starting a new paragraph).---Real +% \emph{typesetting} from the same `.tex' source +% (pretty printable output) has not been tried yet. +%% <- 2011/01/24 -> +The package %%% rather +\emph{``misuses"} \TeX's macro language +for generating HTML code and entirely \emph{ignores} +\TeX's typesetting capabilities.%%%---What about +% such a ``small" \TeX\ with macros only and +% \emph{no} typesetting capabilities ...!? +\end{abstract} +\tableofcontents + +\section{Installing and Usage} +The file 'blog.sty' is provided ready, +\strong{installation} only requires +putting it somewhere where \TeX\ finds it +(which may need updating the filename data + base).\urlfoot{ukfaqref}{inst-wlcf} + +\strong{User commands} are described near their implementation below. + +However, we must present an \strong{outline} of the procedure +for generating HTML files: + +At least one \strong{driver} file and one \strong{source} file are +needed. + +The \strong{driver} file's name is stored in `\jobname'. +It loads 'blog.sty' by +\begin{verbatim} + \RequirePackage{blog} +\end{verbatim} +and uses file handling commands from 'blog.sty' and +\CtanPkgRef{nicetext}{fifinddo} +(cf. `mdoccheat.pdf' from the \ctanpkgref{nicetext} bundle). +It chooses \strong{source} files and the name(s) for the resulting +HTML file(s). It may also need to load local settings, such as +for the language +%% modified 2011/01/25: +(`lang-de.fdf', `lang-en.fdf'), +and settings for converting the editor's text encoding +into the encoding that the head of the resulting HTML file advertises +(`atari.fdf'). + +The driver file can run a terminal dialogue in order to choose source +and target files and settings. So far, I rather have programmed a +dialogue just for converting UTF-8 into an encoding that my +Atari editor xEDIT can deal with +[TODO: present in 'nicetext']. %% 2011/01/24 + +The \strong{source} file(s) should contain user commands defined below +to generate the necessary \xmltagcode{head} section and the +\xmltagcode{body} tags. + +\section{Example} +My ``\TeX-generated +pages"{\footnote{\urlhttpref{www.webdesign-bu.de/uwe\underscorechar + lueck/texmap.htm}}} +use a \strong{driver} file `makehtml.tex'. +To choose a page to generate, I ``uncomment" just one +of several lines that set the ``current conversion job" +from a list. I choose the example of a simple ``site map:" +`texmap.htm' is generated from \strong{source} file `texmap.tex'. + +\begingroup + \MakeOther\|\MakeOther\`\MakeOther\'\MakeOther\< + \MakeActive\ \def{\"u} + \hfuzz=\textwidth \advance \hfuzz by 28pt +\subsection{Driver File \texttt{makehtml.tex}} + \listinginput[5]{1}{makehtml.tex} +\subsection{Source File \texttt{texmap.tex}} + \listinginput[5]{1}{texmap.tex} +\endgroup + +\section{The Package File} +\subsection{Package File Header (Legalize)} + \errorcontextlines=5 + \ResetCodeLineNumbers +\input{blog.doc} +\end{document} + +HISTORY + +2010/11/05 for v0.2 +2010/11/11 for v0.3 +2011/01/23 using readprov and color +2011/01/27 using \urlfoot diff --git a/Master/texmf-dist/source/latex/morehype/gather.tex b/Master/texmf-dist/source/latex/morehype/gather.tex new file mode 100644 index 00000000000..41f508b6335 --- /dev/null +++ b/Master/texmf-dist/source/latex/morehype/gather.tex @@ -0,0 +1,6 @@ +\RequirePackage{myfilist} +\ProvidesFile{gather.tex}[2011/01/25 collect file infos] +\EmptyFileList %%% [readprov.sty,myfilist.sty] +\ReadPackageInfos{blog,hypertoc,texlinks} +\ReadFileInfos{blog,hypertoc,texlinks,atari.fdf,lang-de.fdf,lang-en.fdf,makedoc.cfg,mdoccorr.cfg,gather} +\ListInfos[FileList.txt] diff --git a/Master/texmf-dist/source/latex/morehype/hypertoc.tex b/Master/texmf-dist/source/latex/morehype/hypertoc.tex new file mode 100644 index 00000000000..bd5091f3f5c --- /dev/null +++ b/Master/texmf-dist/source/latex/morehype/hypertoc.tex @@ -0,0 +1,79 @@ +\ProvidesFile{hypertoc.tex}[2011/01/27 documenting hypertoc.sty] +\title{\textsf{hypertoc.sty}\\---\\Decent Links + in Tables of Contents\thanks{This + document describes version + \textcolor{blue}{\UseVersionOf{\jobname.sty}} + of \textsf{\jobname.sty} as of \UseDateOf{\jobname.sty}.}} +% \listfiles +{ \RequirePackage{makedoc} \ProcessLineMessage{} + \MakeJobDoc{18}% %% 2011/01/23 + {\SectionLevelOneParseInput} } +\documentclass{article}%% TODO paper dimensions!? +\input{makedoc.cfg} %% shared formatting settings +\usepackage{color} %% readprov in makedoc.cfg 2011/01/23 +\sloppy +\begin{document} +\maketitle +\begin{abstract}\noindent +'hypertoc.sty' changes macros for the table of contents +so that colored frames to indicate links look acceptable. +In the present version, this is achieved by inserting struts +and only addresses \LaTeX's standard 'article.cls'. +\end{abstract} + +\tableofcontents + +\section{Why} +By default, the 'hyperref' package highlights sectioning titles +as printed in the table of contents (TOC) by red-framed boxes. +It looks horrible, because of +(\textit{i})~the aggressive color and +(\textit{ii})~the irregular, ``random" shapes of the boxes. + +To avoid this, it seems to be standard to use 'hyperref''s +package option `[colorlinks]'. I don't like this either. +It is confusing as to how the printed output will look like, +the chosen color doesn't create a much more pleasant look; +indeed, the publisher's graphical designer may have chosen +colors for printing the table of contents---this design +then is spoiled. + +Therefore I prefer (\textit{a})~choosing a more decent color +and (\textit{b})~using struts so that the boxes have a more +regular shape. + +In a publisher's package I even have found the idea +to make a box for the entire TOC entry, including the page number. +Then the frames look regular indeed, and you need less precision +in moving the mouse for clicking at an entry. +It would be nice if this could be integrated here later. + +\section{Usage} +The file 'hypertoc.sty' is provided ready, installation only requires +putting it somewhere where \TeX\ finds it +(which may need updating the filename data + base).\urlfoot{ukfaqref}{inst-wlcf} %% 2011/01/27 + +Below the `\documentclass' line(s) and above `\begin{document}', +you load 'hypertoc.sty' (as usually) by +\begin{verbatim} + \usepackage{hypertoc} +\end{verbatim} + +This controls the \emph{shapes} of the frames. +The \emph{color} must be chosen by the 'hyperref' package option +`[linkbordercolor]', I have used +\[`linkbordercolor={1 .9 .7},'\] +---cf.~`makedoc.cfg'. + +\section{The Package File} +The package essentially has just \emph{six} code lines at present. + +\input{hypertoc.doc} +\end{document} + +VERSION HISTORY + +2011/01/23 for v0.1, very first +2011/01/24 \ProvidesFile date corrected +2011/01/27 uses \urlfoot diff --git a/Master/texmf-dist/source/latex/morehype/makedoc.cfg b/Master/texmf-dist/source/latex/morehype/makedoc.cfg new file mode 100644 index 00000000000..43d57ed87cc --- /dev/null +++ b/Master/texmf-dist/source/latex/morehype/makedoc.cfg @@ -0,0 +1,40 @@ +\ProvidesFile{makedoc.cfg}[2011/01/24 documentation settings] + +\author{Uwe L\"uck\thanks{\url{http://contact-ednotes.sty.de.vu}}} +% \author{Uwe L\"uck---{\tt http://contact-ednotes.sty.de.vu}} + +%% hyperref: +\RequirePackage{ifpdf} +\usepackage[% + \ifpdf +% bookmarks=false, %% 2010/12/22 +% bookmarksnumbered, + bookmarksopen, %% 2011/01/24!? + bookmarksopenlevel=2, %% 2011/01/23 +% pdfpagemode=UseNone, +% pdfstartpage=10, +% pdfstartview=FitH, + citebordercolor={ .6 1 .6}, + filebordercolor={1 .6 1}, + linkbordercolor={1 .9 .7}, + urlbordercolor={ .7 1 1}, %% playing 2011/01/24 + \else + draft + \fi +]{hyperref} + +\RequirePackage{niceverb}[2011/01/24] +\RequirePackage{readprov} %% 2010/12/08 +\RequirePackage{hypertoc} %% 2011/01/23 +\RequirePackage{texlinks} %% 2011/01/24 +\makeatletter + \@ifundefined{strong} + {\let\strong\textbf} %% 2011/01/24 + {} +\makeatother + +\errorcontextlines=4 +\pagestyle{headings} + +\endinput + diff --git a/Master/texmf-dist/source/latex/morehype/mdoccorr.cfg b/Master/texmf-dist/source/latex/morehype/mdoccorr.cfg new file mode 100644 index 00000000000..bbcadd90e34 --- /dev/null +++ b/Master/texmf-dist/source/latex/morehype/mdoccorr.cfg @@ -0,0 +1,51 @@ +\ProvidesFile{mdoccorr.cfg}[2011/01/27 + local typographical corrections + with makedoc.sty] +%% ... also demonstrates 'niceverb.sty'---see the typeset +%% documentation of the present file in `makedoc.pdf'. +%% +%% |\SetPatternCodes{}| redefines +%% `\PatternCodes' to be used in parsing and replacing +%% (some ``sanitizing"). %% improved line breaks 2010/03/29 +\SetPatternCodes{\MakeOther\\\MakeOther\ } +%% |\StartPrependingChain| initializes setup of a replacement +%% chain: +\StartPrependingChain +%% |\PrependExpandableAllReplacer{}{}{}|: +\PrependExpandableAllReplacer{etc}{etc. }{etc.\ } +%% ... you can keep inter-sentence space after `etc.' +%% by a code line break. +\PrependExpandableAllReplacer{Cf}{Cf. }{Cf.\ } %% 2011/01/12 +\PrependExpandableAllReplacer{cf}{cf. }{cf.\ } %% corr. 2010/03/23 +%% ... but think of `cf.~'. Don't leave `cf.' at code line end! +\PrependExpandableAllReplacer{rarr}{->}{$\to$} %% 2010/11/06 +\PrependExpandableAllReplacer{larr}{<-}{$\gets$} %% 2010/11/06 +% \PrependExpandableAllReplacer{dots}{...}{$\dots$} +%% ... 2010/11/24 ``symmetric" variant of `\textellipsis': +%% allow extra space at line end. +\newcommand*{\PXAR}{\PrependExpandableAllReplacer} +\PXAR{dots}{...}{.\kern\fontdimen3\font.\kern\fontdimen3\font.} +\PXAR{dots }{... }{.\kern\fontdimen3\font.\kern\fontdimen3\font.\ } +\PXAR{TODO}{TODO}{\textcolor{blue}{TODO}} %% 2011/01/27 +%% ... chain starts here, and here |\MakeDocCorrectHook| (silently) +%% enters through a default variant |\SetCorrectHookJobLast| +%% of |\SetCorrectHookJob{}|: +\SetCorrectHookJobLast +%% +%% |\ResetPatternCodes| resets `\PatternCodes' to their default +%% value (which is `\fdPatternCodes'): +\ResetPatternCodes +%% ... restores 'fifinddo' default. +\endinput + +HISTORY +2009/04/05 with makedoc v0.2 +2010/03/11 broke some too long code lines +2010/03/16 rendered `mdoccorr.cfg' +2010/03/22 try \Prepend... +2010/03/23 corrected `cf' +2010/03/29 use \SetPatternCodes etc. +2010/11/06 <- and -> +2010/11/24 `...' ``symmetric variant" of `\textellipsis'; + \StartPrependingChain, no more \MakeExpandableAllreplacer +2011/01/27 blue "TODO" diff --git a/Master/texmf-dist/source/latex/morehype/texlinks.tex b/Master/texmf-dist/source/latex/morehype/texlinks.tex new file mode 100644 index 00000000000..5ea979d5de0 --- /dev/null +++ b/Master/texmf-dist/source/latex/morehype/texlinks.tex @@ -0,0 +1,66 @@ +\ProvidesFile{texlinks.tex}[2011/01/27 documenting texlinks.sty] +\title{\textsf{texlinks.sty}\\---\\\TeX-Related Links + for \textsf{hyperref}, \textsf{blog.sty}\\ + (and maybe more)\thanks{This + document describes version + \textcolor{blue}{\UseVersionOf{\jobname.sty}} + of \textsf{\jobname.sty} as of \UseDateOf{\jobname.sty}.}} +% \listfiles +{ \RequirePackage{makedoc} \ProcessLineMessage{} +% %% 2011/01/24: +% \renewcommand*{\mdSectionLevelOne}{\string\subsection} +% \renewcommand*{\mdSectionLevelTwo}{\string\subsubsection} +% \renewcommand*{\mdSectionLevelThree}{\string\paragraph} + \MakeJobDoc{17}% %% 2011/01/24 + {\SectionLevelThreeParseInput} } +\documentclass{article} %% TODO paper dimensions!? +\input{makedoc.cfg} %% shared formatting settings +\usepackage{color} +\newcommand*{\xmltagcode}[1]{\texttt{<#1>}} +\sloppy +\begin{document} +\maketitle +\begin{abstract}\noindent +'texlinks.sty' provides a couple of shorthands for making hyperlinks +with \ctanpkgref{hyperref}'s `\href' command, linking to URLs that one +often refers to in discussing \TeX-related material. +Especially, TUG material +(including texhax postings and TUGboat articles) and +CTAN pages (package descriptions, directories, Catalogue) +are supported, also the UK~FAQ and Wikipedia +(where much \TeX-related software is described in a + visually appealing manner). +However, up to now I have used them for \emph{HTML} overviews +generated with 'blog.sty'. +They may as well be useful with better known (and better developed) +\TeX\,$\to$\,HTML software such as +\ctanpkgref{tex4ht} or \CtanPkgRef{latex2html}{LaTeX2HTML} +(I don't know). +\end{abstract} + +\tableofcontents + +\section{Usage} +The file 'texlinks.sty' is provided ready, installation only requires +putting it somewhere where \TeX\ finds it +(which may need updating the filename data + base).\urlfoot{ukfaqref}{inst-wlcf} + % \footnote{\url{http://www.tex.ac.uk/cgi-bin/texfaq2html?label=inst-wlcf}} + +Below the `\documentclass' line(s) and above `\begin{document}', +you load 'texlinks.sty' (as usually) by +\begin{verbatim} + \usepackage{texlinks} +\end{verbatim} +Package options and user commands are described near their definitions +below in the implementation section. + +\section{Package File Header (Legalize)} + +\input{texlinks.doc} +\end{document} + +VERSION HISTORY + +2011/01/24 for v0.1, very first +2011/01/27 for v0.2, use \urlfoot{ukfaq} -- cgit v1.2.3