summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/morehype/texlinks.tex
blob: d5eaf0b1659201d87a7fc1e2446bdc9ee5515402 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
\ProvidesFile{texlinks.tex}[2012/12/20 documenting texlinks.sty]
\title{{\Huge\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[fleqn]{article} %% TODO paper dimensions!?
\input{makedoc.cfg}     %% shared formatting settings
\newcommand*{\xmltagcode}[1]{\texttt{<#1>}}
\providecommand*{\CTAN}{\acro{CTAN}}
\providecommand*{\HTML}{\acro{HTML}}
\providecommand*{\URL} {\acro{URL}}
\providecommand*{\TUG} {\acro{TUG}}
\providecommand*{\ctanpkgdref}[1]{%
    \ctanpkgref{#1}\,\urlfoot{CtanPkgRef}{#1}}
\providecommand*{\secref}[1]{Section~\ref{sec:#1}}  %% 2012/12/15
\providecommand*{\codedots}{\code{...}}             %% 2012/12/18
\newenvironment*{example}                           %% 2012/12/19
                {\trivlist
                   \item[\skiplabelsep\bf Example:]}
                {\endtrivlist}
\newcommand*{\skiplabelsep}{\hskip\labelsep}
\newcommand*{\simpleexample}[1]{%
    {\example\fbox{\def~{\string~}%% TODO etc.
                   \strut
                   \CmdSyntaxVerb#1}\skiplabelsep
             for\skiplabelsep
             \fbox{\MakeActiveLet\&\empty
                   \strut
                   #1}%
     \endexample}}
\RequirePackage{filesdo} \MDfinaldatechecks     %% 2012/12/20
\sloppy
\begin{document}
\maketitle
\begin{abstract}\noindent
'texlinks.sty' provides a couple of shorthands for making hyperlinks 
with \ctanpkgref{hyperref}'s\urlpkgfoot{hyperref} `\href' command, 
linking to \URL s                                     %% \ 2012/12/15
that one often refers to in discussing \TeX-related material. 
\URL s for \TUG\ material       %% Especially -> \URL s to 2012/12/16
(including texhax postings and 
 \TUG boat articles) and                              %% \ 2012/12/15
\CTAN\ pages (package descriptions, directories, Catalogue),
% are supported, also                               %% rm. 2012/12/16
the \acro{UK~FAQ},                                %% \acro 2012/12/15
the \LaTeX\ 
and the \TeX\                                           %% 2012/12/16
Wikibook,                                               %% 2011/08/27
and Wikipedia 
(where much \TeX-related software is described in a 
 visually appealing manner)
are generated from minimal identifiers by pure expansion. %% 2012/12/16
% However, up to now                                %% rm. 2012/12/16
I have used them for documenting my packages            %% 2012/12/16
(\acro{PDF}) as well as for                             %% 2012/12/16 
\HTML\ overviews generated with 'blog.sty'.   %% rm. \emph 2012/12/16
They may furthermore                      %% was "as well" 2012/12/17
be useful with better known (and better developed)
\TeX\,$\to$\,\HTML\ software such as              %% \HTML 2012/12/15
\ctanpkgdref{tex4ht} or                               %% d 2012/12/16
\CtanPkgRef{latex2html}{LaTeX2HTML}%
\,\urlpkgfoot{latex2html}                            %% \, 2012/12/16
(I don't know, doubt latter).                     %% doubt 2012/12/16
\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 (Legalese)}    %% ize -> ese 2012/11/09

\input{texlinks.doc}

\ModDates
\CheckDateOfPDFmod{texlinks.sty}
\CheckDateOfPDFmod{texlinks.tex}
\end{document}

VERSION HISTORY

2011/01/24  for v0.1, very first
2011/01/27  for v0.2, use \urlfoot{ukfaq}
2011/07/23  using \acro
2011/08/27  mentioning LaTeX Wikibook in abstract
2011/09/03  \Huge first line
2011/10/10  [fleqn]
2011/10/20  \HTML, \URL
2012/11/09  Legalize -> Legalese
2012/11/28  \ctanpkgdref
2012/12/01  date checks
2012/12/15  \secref, more \acro and \HTML, \TUG
2012/12/16  mod. abstract
2012/12/17  color.sty obsolete, \pdfstringDisable..., mod. abstract
2012/12/18  \secref \provide'd only, \codedots, rm. \pdfstring...
2012/12/19  {example} etc.
2012/12/20  filedate checks again