summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/tlc-article
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2019-06-23 20:57:37 +0000
committerKarl Berry <karl@freefriends.org>2019-06-23 20:57:37 +0000
commit15991533e2ebd1c5de20d764410d809fb1a6ba56 (patch)
tree0d4801187bff854d3eb3b0be3aeaa687b2a0edee /Master/texmf-dist/doc/latex/tlc-article
parentd13f4aa60ac176e565e64bddd1c59f089551b2d0 (diff)
tlc-article (23jun19)
git-svn-id: svn://tug.org/texlive/trunk@51431 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/tlc-article')
-rw-r--r--Master/texmf-dist/doc/latex/tlc-article/GettingStarted.texx1
-rw-r--r--Master/texmf-dist/doc/latex/tlc-article/README.md35
-rwxr-xr-xMaster/texmf-dist/doc/latex/tlc-article/bin/deploy19
-rw-r--r--Master/texmf-dist/doc/latex/tlc-article/data/additional-layout.tex65
-rw-r--r--Master/texmf-dist/doc/latex/tlc-article/data/required-packages.csv9
-rw-r--r--Master/texmf-dist/doc/latex/tlc-article/data/version.csv4
-rw-r--r--Master/texmf-dist/doc/latex/tlc-article/doc/sprint.md9
-rw-r--r--Master/texmf-dist/doc/latex/tlc-article/doc/tlc-article.pdfbin0 -> 335142 bytes
-rw-r--r--Master/texmf-dist/doc/latex/tlc-article/tlc-article.tex (renamed from Master/texmf-dist/doc/latex/tlc-article/GettingStarted.tex)262
-rw-r--r--Master/texmf-dist/doc/latex/tlc-article/tlc-article.texx1
10 files changed, 232 insertions, 173 deletions
diff --git a/Master/texmf-dist/doc/latex/tlc-article/GettingStarted.texx b/Master/texmf-dist/doc/latex/tlc-article/GettingStarted.texx
deleted file mode 100644
index e2195a3dbca..00000000000
--- a/Master/texmf-dist/doc/latex/tlc-article/GettingStarted.texx
+++ /dev/null
@@ -1 +0,0 @@
-\input{GettingStarted.tex}
diff --git a/Master/texmf-dist/doc/latex/tlc-article/README.md b/Master/texmf-dist/doc/latex/tlc-article/README.md
index 0221bc545a5..b8b928f0ed5 100644
--- a/Master/texmf-dist/doc/latex/tlc-article/README.md
+++ b/Master/texmf-dist/doc/latex/tlc-article/README.md
@@ -1,27 +1,26 @@
-#![](data/logo.png)
-The **tlc_article** repository uses a SCRUM framework adapted to standard GitHub
-tooling. **tlc_article** is integrated with Travis-ci.org for continuous
-integration and AllanConsulting.slack.com for centralized notification.
+[tlc-article](data/logo.png)
+
+---
+The goal of **tlc-article** is to simplify document layout. **tlc-article**
+orchestrates a logical arrangement for document header, footer, author,
+abstract, table of contents, and margins.
+[tlc-article.pdf](doc/tlc-article.pdf) is a document instantiated
+using **tlc-article.cls**.
## Installation are done Locally or Globally
### Local Installation
```bash
-$ cd $HOME
-$ git clone git@github.com:Traap/tlc-article.git
-$ cd tlc-article
-$ cp -v tlc-article.cls $HOME/mydoc
-$ cp -v tlc-article.cls $HOME/mydoc/.
+cd $HOME
+git clone git@github.com:Traap/tlc-article.git
+cd tlc-article
+cp -v tlc-article.cls $HOME/mydoc
+cp -v tlc-article.cls $HOME/mydoc/.
```
### Global Installation
```bash
-$ cd $HOME
-$ git clone git@github.com:Traap/tlc-article.git
-$ cd tlc-article
-$ sudo mkdir -p $(kpsewhich -var-value TEXMFLOCAL)/tex/latex/tlc-article
-$ sudo mv -v tlc-article.cls $(kpsewhich -var-value TEXMFLOCAL)/tex/latex/tlc-article/.
-$ sudo mktexlsr $(kpsewhich -var-value TEXMFLOCAL)
+cd $HOME
+git clone git@github.com:Traap/tlc-article.git
+cd tlc-article
+./bin/distribute tlc-article.cls
```
-# Project Management
-Please refer to my [Lightweight Project Mangement](https://github.com/Traap/lpm)
-for the project management strategy I use.
diff --git a/Master/texmf-dist/doc/latex/tlc-article/bin/deploy b/Master/texmf-dist/doc/latex/tlc-article/bin/deploy
new file mode 100755
index 00000000000..ee54d61ae1d
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/tlc-article/bin/deploy
@@ -0,0 +1,19 @@
+#!/bin/bash
+# Deploy a new LaTeX style or package.
+#
+# Usage:
+# deploy tlc-article.cls
+#
+# Note:
+# I use this script to test my deployment before publishing with CTAN.
+# ------------------------------------------------------------------------------
+main() {
+ mkdir -vp $(kpsewhich -var-value TEXMFLOCAL)/tex/latex/${1%.}
+ cp -v $1 $(kpsewhich -var-value TEXMFLOCAL)/tex/latex/${1%.}/.
+ mktexlsr $(kpsewhich -var-value TEXMFLOCAL)
+}
+
+# ------------------------------------------------------------------------------
+# Kick start start this script.
+# ------------------------------------------------------------------------------
+main $@
diff --git a/Master/texmf-dist/doc/latex/tlc-article/data/additional-layout.tex b/Master/texmf-dist/doc/latex/tlc-article/data/additional-layout.tex
new file mode 100644
index 00000000000..9ca4c344bed
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/tlc-article/data/additional-layout.tex
@@ -0,0 +1,65 @@
+% This use case demonstrates tlc-article being extended. All definitions are
+% process during preamble phase. In other words, before your \begin{document}
+% statement.
+
+% ------------------------------------------------------------------------------
+% \makeatletter is used so we can reference commands and definitions defined by
+% tlc-article, which are all prefaced with tlc@.
+\makeatletter
+
+% ------------------------------------------------------------------------------
+% tlc-article.tex (Getting Starting) definitions.
+
+\def\tlcProduct{tlc-article}%
+
+\def\tlcA{\tlcDarkblue{\tlcProduct}}%
+
+\def\tlcAL{\tlcDarkblue{\tlc@additionalLayout}}%
+\def\tlcBL{\tlcDarkblue{tlcBeginLandscape}}%
+\def\tlcDB{\tlcDarkblue{tlcDarkblue}}%
+\def\tlcEL{\tlcDarkblue{tlcEndLandScape}}%
+\def\tlcHF{\tlcDarkblue{\tlc@headerFooter}}%
+\def\tlcLG{\tlcDarkblue{\tlc@logoFile}}%
+\def\tlcNCT{newcolumn type: \tlcDarkblue{L, C} \& \tlcDarkblue{R}}%
+\def\tlcTOC{\tlcDarkblue{tlcTitlePageAndTableOfContents}}%
+\def\tlcVE{\tlcDarkblue{\tlc@versionFile}}%
+
+\def\tlcVC{\tlcDarkblue{tlc@version}}%
+\def\tlcDC{\tlcDarkblue{tlc@date}}%
+\def\tlcSC{\tlcDarkblue{tlc@status}}%
+\def\tlcIC{\tlcDarkblue{tlc@instatution}}%
+\def\tlcPC{\tlcDarkblue{tlc@permission}}%
+
+\def\kpse{\$(kpsewhich -var-value TEXMFLOCAL)}%
+\def\texDist{\kpse}%
+\def\tlcDist{/tex/latex/\tlcProduct}%
+\def\tlcGlobalDist{\texDist\tlcDist}%
+
+\def\tlcHome{\$HOME}%
+\def\tlcMyDoc{\tlcHome/mydoc}%
+
+\def\gitHub{GitHub.com}%
+\def\gitHubUrl{http://\gitHub}%
+
+\def\tlcRepo{git@\gitHub:Traap/\tlcProduct.git}%
+
+\def\tlcPkgFile{data/required-packages.csv}%
+\def\tlcNote{\tlcDarkblue{Note}}%
+
+% ------------------------------------------------------------------------------%
+% Define the column names used by csvreader when reading \packageFile.
+\csvnames{tlcPkgNames}{
+ 1=\name
+ ,2=\description
+}
+
+% Define the table style used to report the required package names and
+% descriptions.
+\csvstyle{tlcPkgStyle}{
+ longtable=|L{3cm}|L{12cm}|
+ ,table head=\hline Name & Description\\\hline\hline\endhead
+ ,late after line=\\\hline
+ ,tlcPkgNames
+}
+
+% ------------------------------------------------------------------------------%
diff --git a/Master/texmf-dist/doc/latex/tlc-article/data/required-packages.csv b/Master/texmf-dist/doc/latex/tlc-article/data/required-packages.csv
index 3249af147e4..4c63b74562b 100644
--- a/Master/texmf-dist/doc/latex/tlc-article/data/required-packages.csv
+++ b/Master/texmf-dist/doc/latex/tlc-article/data/required-packages.csv
@@ -4,10 +4,17 @@ array | An extended implementation of the array and tabular environments wh
csvsimple | The package provides a simple \LaTeX\ interface for the processing of files with comma separated values (CSV); it relies on the key value syntax supported by pgfkeys to simplify usage.
enumitem | This package provides user control over the layout of the three basic list environments: enumerate, itemize and description.
fancyhdr | The package provides extensive facilities, both for constructing headers and footers, and for controlling their use (for example, at times when \LaTeX\ would automatically change the heading style in use).
+fontenc | The package allows the user to select font encodings, and for each encoding provides an interface to `font-encoding specific' commands for each font.
fontenc | The package alows the user to select font encodings, and for each encoding provides an interface to `font-encoding specific' commands for each font.
+geometry | The package provides an easy and flexible user interface to customize page layout, implementing auto-centering and auto-balancing mechanisms so that the users have only to give the least description for the page layout.
geometry | The package provides an easy and flexible user interface to customize page layout, implementing autocentering and auto-balancing mechanisms so that the users have only to give the least description for the page layout.
+glossaries | The glossaries package supports acronyms and multiple glossaries, and has provision for operation in several languages.
graphicx | The package builds upon the graphics package, providing a key-value interface for optional arguments to the `includegraphics' command. This interface provides facilities that go far beyond what the graphics package offers on its own.
hyperref | The hyperref package is used to handle cross-referencing commands in \LaTeX\ to produce hypertext links in the document.
+hyperref | The package is used to handle cross-referencing commands in \LaTeX\ to produce hypertext links in the document.
+inputenc | The package translates various standard and other input encodings into a \LaTeX\ internal language. The internal langage is expressed entierly in \TeX\'s base encoding (standard ASCII printable characters, carriage control tokes and \TeX\ control sequences, the later mostly defined by \LaTeX).
+inputenc | The package translates various standard and other input encodings into a \LaTeX\ internal language. The internal language is expressed entirely in \TeX\'s base encoding (standard ASCII printable characters, carriage control tokens and \TeX\ control sequences, the latter mostly defined by \LaTeX).
+jancyhdr | The package provides extensive facilities, both for constructing headers and footers, and for controlling their use (for example, at times when \LaTeX\ would automatically change the heading style in use).
lastpage | Reference the number of pages in your \LaTeX\ document through the introduction of a new label which can be referenced like `gpageref{LastPage}' to give a reference to the last page of a document.
listings | The package enables the user to typeset programs (programming code) within \LaTeX; the source code is read directly by \TeX\ -- no frontend processor is needed.
lmodern | Latin modern fonts
@@ -17,9 +24,11 @@ multicol | Multicol defines a multicols environment which typesets text in mul
parskip | Simply changing `gparskip' and `parindent' leaves a layout that is untidy; this package (though it is no substitute for a properly-designed class) helps alleviate this untidiness.
pdflscape | The package adds PDF support to the landscape environment of package lscape, by setting the PDF /Rotate page attribute.
pdfpages | This package simplifies the inclusion of external multipage PDF documents in \LaTeX\ documents.
+pdf-pie | Ths package provides the means to draw pie (and variant charts) using PGF/TikZ.
spverbatim | The spverbatim package provides an `gspverb' macro that is analogous to 'verb' and an spverbatim environment that is analogous to verbatim with the difference being that `spverb' and spverbatim allow \LaTeX\ to break lines at space characters.
tabularx | The package defines an environment tabularx, an extension of tabular which has an additional column designator, X, which creates a paragraph-like column whose width automatically expands so that the declared width of the environment is filled.
textcomp | The package supports the Text Companion fonts, which provide many text symbols (such as baht, bullet, copyright, musicalnote, onequarter, section, and yen), in the TS1 encoding.
titling | The titling package provides control over the typesetting of the `gmaketitle' command and `thanks' commands, and makes the `title', `author' and `date' information permanently available.
tocloft | Provides control over the typography of the Table of Contents, List of Figures and List of Tables, and the ability to create new `List of ...'. The ToC `gparskip' may be changed.
+todonotes | The package lets the user mark things to do later, in a simple and visually appealing way. The package takes several options to enable customization / fine-tuning of the visual appearance.
xcolor | The package starts from the basic facilities of the color package, and provides easy driver-independent access to several kinds of color tints, shades, tones, and mixes of arbitrary colors.
diff --git a/Master/texmf-dist/doc/latex/tlc-article/data/version.csv b/Master/texmf-dist/doc/latex/tlc-article/data/version.csv
index a73581af390..f3383098160 100644
--- a/Master/texmf-dist/doc/latex/tlc-article/data/version.csv
+++ b/Master/texmf-dist/doc/latex/tlc-article/data/version.csv
@@ -1,2 +1,2 @@
-version | date | status | institution | permission
-v1.0.10 | May 30th, 2018 | Released | Traap | BSD-3-Clause
+version | date | status | institution | permission
+v1.0.17 | June 20th, 2019 | Released | Traap | BSD-3-Clause
diff --git a/Master/texmf-dist/doc/latex/tlc-article/doc/sprint.md b/Master/texmf-dist/doc/latex/tlc-article/doc/sprint.md
deleted file mode 100644
index 19be913b8fb..00000000000
--- a/Master/texmf-dist/doc/latex/tlc-article/doc/sprint.md
+++ /dev/null
@@ -1,9 +0,0 @@
-| Fcevag | Fgneg | Raq | Cbvagf | Vffhrf |
-| ------ | ---------- | ---------- | ------: | ------: |
-| i1.0.6 | 2018-01-01 | 2018-03-18 | 1 | 1 |
-| i1.0.5 | 2018-01-01 | 2018-03-17 | 5 | 5 |
-| i1.0.4 | 2017-01-17 | 2017-02-02 | 11 | 6 |
-| i1.0.3 | 2017-01-14 | 2017-01-16 | 9 | 5 |
-| i1.0.2 | 2017-01-11 | 2017-01-13 | 5 | 3 |
-| i1.0.1 | 2017-01-08 | 2017-01-10 | 9 | 8 |
-| i1.0.0 | 2017-01-05 | 2017-01-07 | 10 | 5 |
diff --git a/Master/texmf-dist/doc/latex/tlc-article/doc/tlc-article.pdf b/Master/texmf-dist/doc/latex/tlc-article/doc/tlc-article.pdf
new file mode 100644
index 00000000000..97b3bd5fdfc
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/tlc-article/doc/tlc-article.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/tlc-article/GettingStarted.tex b/Master/texmf-dist/doc/latex/tlc-article/tlc-article.tex
index a1106389e4e..dae2f37ab44 100644
--- a/Master/texmf-dist/doc/latex/tlc-article/GettingStarted.tex
+++ b/Master/texmf-dist/doc/latex/tlc-article/tlc-article.tex
@@ -1,64 +1,18 @@
\documentclass[12pt]{tlc-article}
% ------------------------------------------------------------------------------
-% \makeatletter is used so we can reference commands and definitions defined by
-% tlc-article, which are all prefaced with tlc@.
-\makeatletter
-
-% ------------------------------------------------------------------------------
-
-\def\tlcProduct{tlc-article}
-
-\def\tlcA{\tlcDarkblue{\tlcProduct}}
-
-\def\tlcAL{\tlcDarkblue{\tlc@additionalLayout}}
-\def\tlcBL{\tlcDarkblue{tlcBeginLandscape}}
-\def\tlcDB{\tlcDarkblue{tlcDarkblue}}
-\def\tlcEL{\tlcDarkblue{tlcEndLandScape}}
-\def\tlcHF{\tlcDarkblue{\tlc@headerFooter}}
-\def\tlcLG{\tlcDarkblue{\tlc@logoFile}}
-\def\tlcNCT{newcolumn type: \tlcDarkblue{L, C} \& \tlcDarkblue{R}}
-\def\tlcTOC{\tlcDarkblue{tlcTitlePageAndTableOfContents}}
-\def\tlcVE{\tlcDarkblue{\tlc@versionFile}}
-
-\def\tlcVC{\tlcDarkblue{tlc@version}}
-\def\tlcDC{\tlcDarkblue{tlc@date}}
-\def\tlcSC{\tlcDarkblue{tlc@status}}
-\def\tlcIC{\tlcDarkblue{tlc@instatution}}
-\def\tlcPC{\tlcDarkblue{tlc@permission}}
-
-\def\kpse{\$(kpsewhich -var-value TEXMFLOCAL)}
-\def\texDist{\kpse}
-\def\tlcDist{/tex/latex/\tlcProduct}
-\def\tlcGlobalDist{\texDist\tlcDist}
-
-\def\tlcHome{\$HOME}
-\def\tlcMyDoc{\tlcHome/mydoc}
-
-\def\gitHub{GitHub.com}
-\def\gitHubUrl{http://\gitHub}
-
-\def\tlcRepo{git@\gitHub:Traap/\tlcProduct.git}
-
-\def\tlcPkgFile{data/required-packages.csv}
-\def\tlcNote{\tlcDarkblue{Note}}
-
-% ------------------------------------------------------------------------------
-
\begin{document}
% ------------------------------------------------------------------------------
-
\tlcTitlePageAndTableOfContents
- {Getting Started}
+ {tlc-article}
{Gary Allan Howard}
- {Getting Started guide covers how to install \tlcA\ both globally and
- locally, describes the general use case, how to customize your \tlcA\
- environment, describes the commands \tlcA\ implements, and reveals the
- packages \tlcA\ depends upon.}
+ {The \tlcA\ `Getting Started Guide' covers how to install \tlcA\ both globally
+ and locally, describes the general use case, how to customize your \tlcA\
+ environment, describes the commands \tlcA\ implements, and reveals the
+ packages \tlcA\ depends upon.}
% ------------------------------------------------------------------------------
-
\section{Installation}
This section describes how to install \tlcA\ either globally to make it
available to your \LaTeX\ environment or locally to the document you are
@@ -66,6 +20,7 @@ authoring. And, this section identifies the prerequisites you must meet in
order to clone a repository from GitHub.com and install software on your
computer.
+% ------------------------------------------------------------------------------
\subsection{Prerequisites}
The following prerequisites are needed.
\begin{description}[style=nextline]
@@ -78,45 +33,48 @@ The following prerequisites are needed.
\item[Enable your SSH key] The following instructions enable your SSH key so
you to not have to enter the passphrase for each git command.
-
- \begin{enumerate}
- \item eval \$(ssh-agent -s)
- \item ssh-add ~/.ssh/your-private-key
- \item enter your passphrase
- \end{enumerate}
-
\end{description}
+\begin{lstlisting}[language=bash]
+eval \$(ssh-agent -s)
+ssh-add ~/.ssh/your-private-key
+\end{lstlisting}
+
+% ------------------------------------------------------------------------------
\subsection{Local installation}
A local installation is done by installing \tlcA\ into
/the/path/to/your/document. Assuming your document is located at \tlcMyDoc\ the
following shell commands will make \tlcA\ available to your document.
-\begin{enumerate}
- \item cd \tlcHome
- \item git clone \tlcRepo\
- \item cd \tlcProduct\
- \item mkdir \tlcMyDoc
- \item cp -v \tlcProduct.cls \tlcMyDoc/.
-\end{enumerate}
+\begin{lstlisting}[language=bash]
+cd $HOME
+git clone git@GitHub.com:Traap/tlc-article.git
+cd tlc-article
+mkdir $HOME/mydoc
+cp -v tlc-article.cls $HOME/mydoc/.
+\end{lstlisting}
+% ------------------------------------------------------------------------------
\clearpage
\subsection{Global installation}
A global installation is done by installing \tlcA\ into your /path/to/your/texmf
directory. Assuming a TexLive installation exists at \texDist\ the following
shell commands will make \tlcA\ available to your \LaTeX\ environment.
-\begin{enumerate}
- \item cd \tlcHome
- \item git clone \tlcRepo\
- \item cd \tlcProduct\
- \item sudo mkdir -p \tlcGlobalDist
- \item sudo mv -v \tlcProduct.cls \tlcGlobalDist/.
- \item sudo mktexlsr \texDist\
-\end{enumerate}
+\begin{lstlisting}[language=bash]
+cd $HOME
+git clone git@GitHub.com:Traap/tlc-article.git
+cd tlc-article
+sudo mkdir -p $(kpsewhich -var-value TEXMFLOCAL)/tex/latex/tlc-article
+sudo cp -v tlc-article.cls $(kpsewhich -var-value TEXMFLOCAL)/tex/latex/tlc-article/.
+sudo mktexlsr $(kpsewhich -var-value TEXMFLOCAL)
+\end{lstlisting}
\bigskip
-\tlcNote\ You may remove your local installation by removing \tlcA.
+
+\todo[inline]{%
+ \tlcNote: You may remove your local installation by removing \tlcA.%
+}%
% ------------------------------------------------------------------------------
\clearpage
@@ -124,7 +82,7 @@ shell commands will make \tlcA\ available to your \LaTeX\ environment.
The goal of \tlcA\ is to simplify document layout. \tlcA\ orchestrates a
logical arrangement for document header, footer, author, abstract, table of
contents, and margins. The following sections outline the default
-implementation for each part \tlcA\ organizes.
+implementation for each part \tlcA\ organizes.
\tlcNote\ This document was typeset using the instructions provided throughout
this section.
@@ -136,6 +94,8 @@ this section.
\caption{Document Layout}
\label{fig:layout}
\end{figure}
+
+% ------------------------------------------------------------------------------
\subsection{documentclass \tlcA}
\tlcA\ extends the article document class. \tlcA\ provide options directly to
the article document class. As an example, the Author can specify the font as
@@ -145,6 +105,7 @@ follows:
\documentclass[12pt]{tlc-article}
\end{lstlisting}
+% ------------------------------------------------------------------------------
\subsection{Title, Author \& Abstract} \label{sec:TAA}
\tlcA\ has a macro \tlcTOC\ that can be used to set the document title, document
author, document abstract, and establish the Table of Contents. The sample
@@ -157,107 +118,130 @@ below reveals how to use \tlcTOC.
{Document Abstract}
\end{lstlisting}
+% ------------------------------------------------------------------------------
\subsection{Table of Contents}
The Table of Contents immediately follows the document abstract on page 1, uses
dark blue for content, dots separate table of contents sections and page number,
and uses roman numerals.
+% ------------------------------------------------------------------------------
\subsection{Header \& Footer}
fancyhdr is used to render the header and footer. The Author can override the
-\tlcA\ by providing an implementation in \tlcHF\, or augment \tlcA\
+\tlcA\ by providing an implementation in \tlcHF\, or augment \tlcA\
application by providing \tlcVE. The sections below show the placement \tlcA\
uses when writing objects, and where the objects are defined.
-\tlcNote\ \tlcA\ ignors \tlcVE\ when \tlcHF\ is defined.
+\bigskip
+
+\todo[inline]{%
+ \tlcNote: \tlcA\ ignores \tlcVE\ when \tlcHF\ is defined.
+}%
+
-\subsubsection*{Header}
+% ------------------------------------------------------------------------------
+\subsubsection*{Header}
\begin{description}
\item[lhead] When \tlcLG\ is found, logo.
\item[chead] Document Title
\item[rhead] When \tlcVE\ is present, status, date, and version columns.
\end{description}
+% ------------------------------------------------------------------------------
\subsubsection*{Footer}
-
\begin{description}
- \item[lfoot] When \tlcVE\ is present, instatution column.
- \item[cfoot] When \tlcVE\ is present, permission column.
+ \item[lfoot] When \tlcVE\ is present, institution column.
+ \item[cfoot] When \tlcVE\ is present, permission column.
\item[rfoot] Page 1 of N.
\end{description}
+% ------------------------------------------------------------------------------
\subsubsection*{Rule width}
-A 0.1pt rule witdh is placed below the document header and above the document
+A 0.1pt rule width is placed below the document header and above the document
footer.
% ------------------------------------------------------------------------------
-
\clearpage
\section{Customization}
This section describes how \tlcA\ can be customized by using the file-hooks
\tlcA\ check for. \tlcA\ default implementation will be used when the
-file-hooks are now found.
+file-hooks are not found.
-% ------------------------------------------------------------------------------
+\bigskip
+\todo[inline]{%
+ \tlcNote: \tlcA\ consumes \tlcAL\ \& \tlcHF\ during the preamble compilation
+ phase.
+}%
+
+% ------------------------------------------------------------------------------
\subsection{\tlcAL}
\tlcA\ will use whatever \LaTeX\ definitions are found in \tlcAL\ when it
exists. The file-check is shown
below:
\begin{lstlisting}[basicstyle=\tiny]
- \IfFileExists{docstyle/additional-layout.tex}
- {\input{docstyle/additional-layout.tex}}
+ \IfFileExists{data/additional-layout.tex}
+ {\input{data/additional-layout.tex}}
{}
\end{lstlisting}
% ------------------------------------------------------------------------------
-
\subsection{\tlcHF}
In the absence of \tlcAL\, \tlcA\ has a builtin header and footer strategy that
is base on \textit{fancyhdr}, \textit{titling}, and \textit{lastpage} \LaTeX\
packages. The default implementation is show below:
\begin{lstlisting}[basicstyle=\tiny]
- \IfFileExists{\tlc@logoFile}
+\IfFileExists{\tlc@headerFooter}%
+{ % use the customer header and footer defined by \tlc@headerfooter
+ \input{\tlc@headerFooter}%
+}%
+{ % Else : header and footer applied to all pages.
+ \IfFileExists{\tlc@logoFile}%
{ % Typeset the logo in the left side of the document header.
- \lhead{\includegraphics[width=3cm,height=1cm]{\tlc@logoFile}}
- }
+ \lhead{\includegraphics[width=3cm,height=1cm]{\tlc@logoFile}}%
+ }%
{% Else: no operation because tlc@logoFile does not exist.
- }
+ }%
+ %
% Typeset the title in the center of the document header.
- \chead{\large{\thetitle}}
+ %
+ \chead{\large{\thetitle}}%
+ %
% Typeset version information in the right side of the document header.
- \IfFileExists{\tlc@versionFile}
- {
+ %
+ \IfFileExists{\tlc@versionFile}%
+ {%
% document status, document date and document version.
- \rhead{\tiny \tlc@status \\ \tlc@date \\ \tlc@version}
+ \rhead{\tiny \tlc@status \\ \tlc@date \\ \tlc@version}%
% document owner. This maybe a person or company name.
- \lfoot{\tiny \tlc@instatution}
+ \lfoot{\tiny \tlc@institution}%
% document license. This maybe a license or word like confidential.
- \cfoot{\tiny \tlc@permission}
- }
+ \cfoot{\tiny \tlc@permission}%
+ }%
{% Else: no operation because tlc@versionFile does not exist.
- }
- \renewcommand{\headrulewidth}{0.1pt}
- % eliminate head height too small warning, which is occurring because
+ }%
+ \renewcommand{\headrulewidth}{0.1pt}%
+ % Eliminate head height too small warning, which is occurring because
% we are using multiple lines in our header.
- \setlength\headheight{52pt}
- % % footer applied to all pages.
- \rfoot{\tiny{page \thepage~of~\pageref{LastPage}}}
- \renewcommand{\footrulewidth}{0.1pt}
- % we want our header and footer to remain consistent with a table of
- % contents that span multiple pages.
- \AtBeginDocument{\addtocontents{toc}{\protect\thispagestyle{fancy}}}
+ \setlength\headheight{34.0pt}%
+ % footer applied to all pages.
+ \rfoot{\tiny{Page \thepage~of~\pageref{LastPage}}}%
+ \renewcommand{\footrulewidth}{0.1pt}%
+}%
\end{lstlisting}
-The default implementation can be overridden by defining \tlcHF.
+The default implementation can be overridden by defining \tlcHF.
-\tlcNote\ When \tlcHF\ exists and is empty, your document will be typeset
-with the defaults from document-class \tlcDarkblue{article}.
+\tlcVspace
-% ------------------------------------------------------------------------------
+\todo[inline]{%
+ \tlcNote: When \tlcHF\ exists and is empty, your document will be typeset with
+ the defaults from document-class \tlcDarkblue{article}.
+}%
+% ------------------------------------------------------------------------------
\clearpage
\subsection{\tlcVE} \label{sec:version}
\tlcA\ will populate the builtin header and footer with information extracted
@@ -281,11 +265,11 @@ column names:
field is used to tell the reader the author name or company name.
\item[permission] The permission value is typeset in the cfoot area. This
- field is used to identify confidentiality or a particular license.
+ field is used to identify confidentiality or a particular license.
\end{description}
-The extaction methods are shown below.
+The exaction methods are shown below.
\begin{lstlisting}[basicstyle=\tiny]
% Extract document status, document date and document version from
% \tlc@versionFile.
@@ -304,48 +288,50 @@ The extaction methods are shown below.
% Define extractions macros when \tlc@versionFile exists.
\IfFileExists{\tlc@versionFile}
- {
+ {
\def\tlc@version{\tlcVersionPart{\version}}
\def\tlc@date{\tlcVersionPart{\date}}
\def\tlc@status{\tlcVersionPart{\status}}
\def\tlc@instatution{\tlcVersionPart{\version}}
\def\tlc@permission{\tlcVersionPart{\version}}
}
- {% Else: no operation because tlc@versionFile does not exist.
+ {% Else: no operation because tlc@versionFile does not exist.
}
\end{lstlisting}
% ------------------------------------------------------------------------------
-
\subsection{\tlcLG}
\tlcA\ will typeset the lhead area with \tlcLG\ when it is present. Make sure
your logo's height is not larger than 34pt to avoid `Package Fancyhdr Warning:
\\headheight is to small' warning.
% ------------------------------------------------------------------------------
-
\clearpage
\section{Definitions \& Commands}
\subsection{\tlcBL}
Page layout is rotated 90\textdegree\ clockwise resulting in a landscape page
orientation. Landscape orientation remains active until \tlcEL.
+% ------------------------------------------------------------------------------
\subsection{\tlcEL}
-Page layout is returned to portrate orientation when \tlcEL\ is reached.
+Page layout is returned to portrait orientation when \tlcEL\ is reached.
+% ------------------------------------------------------------------------------
\subsection{\tlcDB}
-\tlcDB\ is used throughout this document to render text using rbg\{0,0,0.5\}.
+\tlcDB\ is used throughout this document to render text using rbg\{0,0,0.5\}.
\tlcDB\ is safe to use within your document.
+% ------------------------------------------------------------------------------
\subsection{\tlcTOC}
-\tlcTOC\ creates the document layout showen in Figure \ref{fig:layout}. Section
+\tlcTOC\ creates the document layout shown in Figure \ref{fig:layout}. Section
\ref{sec:TAA} shows an example implementation.
+% ------------------------------------------------------------------------------
\subsection{\tlcNCT}
New \tlcNCT\ are Left, Center, and Right, respectively are
designed to use with longtable. Data is wrapped within a table cell. The
parameter defines the column width. As an example, L{2cm} yields a Left
-aligned, ragged right, wrapped text within a 2cm wide cell.
+aligned, ragged right, wrapped text within a 2cm wide cell.
\begin{lstlisting}[basicstyle=\tiny]
\newcolumntype{L}[1]{>{\raggedright\let\newline\\\arraybackslash}p{#1}}
@@ -353,21 +339,25 @@ aligned, ragged right, wrapped text within a 2cm wide cell.
\newcolumntype{R}[1]{>{\raggedleft\let\newline\\\arraybackslash}p{#1}}
\end{lstlisting}
+% ------------------------------------------------------------------------------
\subsection{\tlcAL}
\tlcAL\ is an architectural hook the Author should use when it becomes necessary
to use packages not provided by \tlcA\, and to design commands that are specific
to your document.
+% ------------------------------------------------------------------------------
\subsection{\tlcHF}
\tlcHF\ is an architectural hook the Author should use to completely override
the document layout \tlcA\ implements.
+% ------------------------------------------------------------------------------
+\clearpage
\subsection{\tlcVE}
\tlcVE\ is by used \tlcA\ to populate the document header \& footer. Refer to
section \ref{sec:version} for \tlcVE\ definitions. \tlcVE\ is not
used by \tlcA\ when \tlcHF\ is define. However, you might want to use the
version hook by defining \tlcVE\ and using the commands below to extract data
-from \tlcVE in your \tlcHF.
+from \tlcVE\ in your \tlcHF.
\begin{enumerate}
\item \tlcVC\
\item \tlcDC\
@@ -376,31 +366,17 @@ from \tlcVE in your \tlcHF.
\item \tlcPC\
\end{enumerate}
-\subsection{\tlcLG}
-\tlcLG\ is used to place your logo in the header created by \tlcA.
% ------------------------------------------------------------------------------
+\subsection{\tlcLG}
+\tlcA\ places \tlcLG\ in your header when defined.
+% ------------------------------------------------------------------------------
\clearpage
\section{Required Packages}
This section documents the dependencies of the required package tlc-article has.
Package names are listed in alphabetical order. A complete description of each
-package is found at \url{http://www.ctan.org/}. At this writing, you can type in the
-package name and press the search button to learn more about each package.
-
-% Define the column names used by csvreader when reading \packageFile.
-\csvnames{tlcPkgNames}{
- 1=\name
- ,2=\description
-}
-
-% Define the table style used to report the required package names and
-% descriptions.
-\csvstyle{tlcPkgStyle}{
- longtable=|L{3cm}|L{12cm}|
- ,table head=\hline Name & Description\\\hline\hline\endhead
- ,late after line=\\\hline
- ,tlcPkgNames
-}
+package is found at \url{http://www.ctan.org/}. At this writing, you can type in
+the package name and press the search button to learn more about each package.
% Render pckFile using pckStyle as a longtable.
\csvreader[tlcPkgStyle, separator=pipe]{\tlcPkgFile}{}{\name & \description}
diff --git a/Master/texmf-dist/doc/latex/tlc-article/tlc-article.texx b/Master/texmf-dist/doc/latex/tlc-article/tlc-article.texx
new file mode 100644
index 00000000000..88fdfc34b7b
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/tlc-article/tlc-article.texx
@@ -0,0 +1 @@
+\input{tlc-article.tex}