summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/fadingimage/doc/fadingimage.tex
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/fadingimage/doc/fadingimage.tex')
-rw-r--r--macros/latex/contrib/fadingimage/doc/fadingimage.tex69
1 files changed, 32 insertions, 37 deletions
diff --git a/macros/latex/contrib/fadingimage/doc/fadingimage.tex b/macros/latex/contrib/fadingimage/doc/fadingimage.tex
index 043d13b129..2aa6637e95 100644
--- a/macros/latex/contrib/fadingimage/doc/fadingimage.tex
+++ b/macros/latex/contrib/fadingimage/doc/fadingimage.tex
@@ -1,60 +1,55 @@
-\documentclass[11pt]{article}
-\usepackage{geometry,indentfirst,titlesec,authblk,hyperref}
+\documentclass[11pt,svgnames]{article}
+\usepackage{geometry,titlesec,authblk,hyperref,hologo}
\titleformat*{\section}{\bfseries\large}
-\usepackage{datetime}
-\usepackage[libertine,mono=false]{libertine}
+\hologoFontSetup{general=\sffamily}
+\usepackage{datetime}\yyyymmdddate
+\usepackage[libertine,mono=false]{newtx}
\usepackage{fadingimage}
-\hypersetup{colorlinks,urlcolor=moducolor}
-\definecolor{pkgcolor}{Hsb}{103,.8,.5}
-\definecolor{moducolor}{Hsb}{290,.8,.5}
-\definecolor{cmdcolor}{Hsb}{188,.8,.5}
-\def\pkg#1{\texorpdfstring{\textcolor{pkgcolor}{
- \href{https://ctan.org/pkg/#1}{\textsf{#1}}}}{“#1”}}
-\def\mode#1{\texorpdfstring{\textcolor{moducolor}{\textsf{#1}}}{“#1”}}
-\def\cmd#1{\texorpdfstring{\textcolor{cmdcolor}{\textsf{#1}}}{“#1”}}
-\def\datechange#1#2{%
- \noindent{\makebox[\textwidth][r]{\color{H7}\rule{1.15\textwidth}{.4pt}}}
- \noindent\makebox[0pt][r]{\makebox[-3em][r]{\small\textbf{\textcolor{H7}{#1}}}\;\;}{\sffamily Update: \ignorespaces#2}}
-
-\title{\bfseries The \pkg{FadingImage} Package}
-\author{Hsia Mingyu, \href{https://www.hdu.edu.cn}{Hangzhou Dianzi University}}
-\yyyymmdddate\date{\today}
-\affil{\href{mailto:xiamyphys@gmail.com}{\ttfamily xiamyphys@gmail.com}}
-\date{\today\quad Version 0.1d\thanks{\url{https://github.com/xiamyphys/FadingImage}}}
-\begin{document}
+\hypersetup{colorlinks,urlcolor=MidnightBlue}
+\def\pkg#1{\textcolor{DarkGreen}{\textsf{#1}}}
+\def\mode#1{\textcolor{Indigo}{\textsf{#1}}}
+\def\cmd#1{\textcolor{MidnightBlue}{\texttt{\string#1}}}
+
+\title{\bfseries The \pkg{fadingimage} Package}
+\author{Mingyu Hsia, \href{mailto:xiamyphys@gmail.com}{\ttfamily xiamyphys@gmail.com}}
+\affil{Hangzhou Dianzi University}
+\date{\today\quad Version 0.2a\thanks{\url{https://github.com/xiamyphys/fadingimage}}}
+\begin{document}
\maketitle
\UPFadingImage[trim={0 {.96\paperheight} 0 0},clip]{Beautiful-realities}
\LOWFadingImage[trim={0 0 0 {.96\paperheight}},clip]{Beautiful-realities}
\vspace{-6ex}
\begin{abstract}
-This is \textsf{\textbf{not only the document but also the demo}} for the \pkg{FadingImage} package, which provides three commands for adding fading full width picture at the top, bottom or both of them on a page. And this package is used for my template \pkg{LiteBook} and \pkg{LiteSolution}.
+
+This is \textsf{\textbf{not only the document but also the demo}} for the \pkg{fadingimage} package, which provides three commands for adding fading full width picture at the top, bottom or both of them on a page. This package is contained in the \pkg{LiteBook} and \pkg{LiteSolution} class.
+
+Welcome to feedback bugs or ideas via email \href{mailto:xiamyphys@gmail.com}{\ttfamily xiamyphys@gmail.com} or \href{https://github.com/xiamyphys/fadingimage}{GitHub}.
+
\end{abstract}
-\section{The purpose of this package}
-This package provides three commands for adding fading full width picture at the top or bottom of a page. Welcome to feedback bugs or ideas via email \href{mailto:xiamyphys@gmail.com}{\ttfamily xiamyphys@gmail.com} or \href{https://github.com/xiamyphys/fadingimage}{GitHub}.
+\section{Installing \pkg{fadingimage} and loading it}
This package requires \pkg{tikz} package to node images and \pkg{fading} library to support fading image.
-\section{Loading \pkg{FadingImage}}
-I strongly advise you to use terminal/cmd to implement the commands to update all the packages (and install this package) to the latest version or switch to portable version instead
+Simply download \verb|fadingimage.cls| file from \href{https://github.com/xiamyphys/fadingimage}{GitHub} or \href{https://ctan.org/pkg/fadingimage}{CTAN} and save it under your working directory. However, I strongly suggest to use terminal to install and update all packages to the latest version
+
\begin{verbatim}
- sudo tlmgr update --self --all
+ sudo tlmgr update --self --all
\end{verbatim}
+To learn more, please refer to \href{https://tex.stackexchange.com/questions/55437/how-do-i-update-my-tex-distribution}{How do I update my \hologo{TeX} distribution?}
+
\section{Commands \cmd{UPFadingImage}, \cmd{LOWFadingImage} and \cmd{UPLOWFadingImage}}
-\begin{small}
-\begin{verbatim}
- \UPFadingImage [<keyval list>]{<file>} \LOWFadingImage[<keyval list>]{<file>}
- \UPFadingImage [<keyval list>]{<file>} [<keyval list>]{<file>}
-\end{verbatim}
-\end{small}
-The first two commands all have 2 variables and the first one is optional. The second variable of the commands can assign the image that you want to insert, and the first one can assign the parameters of command \cmd{includegraphics}, such as clip to the inserted image.
+\begin{small}\begin{verbatim}
+ \UPFadingImage [<keyval list>]{<file>} \LOWFadingImage[<keyval list>]{<file>}
+ \UPLOWFadingImage[<keyval list>]{<file>}[<keyval list>]{<file>}
+\end{verbatim}\end{small}
-The third command is a combination of the first two commands and it will call the \cmd{tikz} environment for only once time to reduce compile time.
+The first two commands all have 2 variables and the first one is optional. The second variable of the commands can assign the image that you want to insert, and the first one can assign the parameters of command \cmd{includegraphics}, such as clip to the inserted image.
-If a star (*) is added after the commands (such as \verb|\UPFadingImage*[...]{...}|), then the image you inserted won't be faded.
+The third command is just a combination of the first two commands. If a star (*) is added after the commands above, the image you inserted won't be faded.
\end{document} \ No newline at end of file