summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/ditaa/ditaa.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2018-10-18 20:28:01 +0000
committerKarl Berry <karl@freefriends.org>2018-10-18 20:28:01 +0000
commit0bd86e39a67aaac4274bbf501f97827394ad6a32 (patch)
tree822b16e7de130dd51208742176071cb8c89944f8 /Master/texmf-dist/doc/latex/ditaa/ditaa.tex
parent7886a204cd657bd21f4e64ab7125e477a4322494 (diff)
ditaa (18oct18)
git-svn-id: svn://tug.org/texlive/trunk@48932 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/ditaa/ditaa.tex')
-rw-r--r--Master/texmf-dist/doc/latex/ditaa/ditaa.tex108
1 files changed, 108 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/ditaa/ditaa.tex b/Master/texmf-dist/doc/latex/ditaa/ditaa.tex
new file mode 100644
index 00000000000..9a3520c685f
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/ditaa/ditaa.tex
@@ -0,0 +1,108 @@
+\documentclass[pagesize=auto]{scrartcl}
+
+\addtokomafont{title}{\rmfamily}
+
+\title{The \textsf{ditaa} package}
+\author{Hiroshi Ukai}
+\date{2018/10/18}
+
+
+\usepackage{verbatim}
+\def\imagepath{./resources}
+\usepackage[imagepath=\imagepath]{ditaa}
+\graphicspath{ {\imagepath/} }
+
+\begin{document}
+
+\maketitle
+
+\noindent
+The \LaTeX\ \textsf{ditaa} package renders your ascii art inside your LaTeX files into pretty image files which you can use them in your papers.
+
+\minisec{Usage:}
+To \texttt{usepackage} \textbf{ditaa}, typically do following.
+\begin{verbatim}
+ \def\imagepath{./resources}
+ \usepackage[imagepath=\imagepath]{ditaa}
+ \graphicspath{ {\imagepath/} }
+\end{verbatim}
+
+A vaiable \texttt{\textbackslash imagepath} points a directory that your images reside.
+Under it, you need to create a directory \texttt{ditaa} in advance.
+In this directory, \texttt{ditaa} environment creates its working files.
+
+\minisec{Features:}
+%
+This is a ditaa diagram example.
+\begin{verbatim}
+ \begin{ditaa}[8cm]{ditaa caption example}{ditaaexample}
+ +--------+ +-------+ +-------+
+ | | --+ ditaa +--> | |
+ | Text | +-------+ |diagram|
+ |Document| |!magic!| | |
+ | {d}| | | | |
+ +---+----+ +-------+ +-------+
+ : ^
+ | Lots of work |
+ +-------------------------+
+ \end{ditaa}
+\end{verbatim}
+
+The fragment above will be rendered into following diagram.
+
+\begin{ditaa}[8cm]{ditaa caption example}{ditaaexample}
+ +--------+ +-------+ +-------+
+ | | --+ ditaa +--> | |
+ | Text | +-------+ |diagram|
+ |Document| |!magic!| | |
+ | {d}| | | | |
+ +---+----+ +-------+ +-------+
+ : ^
+ | Lots of work |
+ +-------------------------+
+\end{ditaa}
+\pagebreak
+And you can specify image width like this Figure.\ref{fig:ditaaexample2}.
+
+\begin{verbatim}
+ \begin{ditaa}[6cm]{ditaa caption example2}{ditaaexample2}
+ +---------+
+ | cBLU |
+ | |
+ | +----+
+ | |cPNK|
+ | | |
+ +----+----+
+ \end{ditaa}
+\end{verbatim}
+
+To denote your diagram, you can do
+
+\begin{verbatim}
+
+ Figure~\ref{fig:ditaaexample2}
+
+\end{verbatim}
+
+, where \texttt{ditaaexample2} is the second argument you gave to the \texttt{ditaa} environment as you see above.
+The prefix \texttt{fig:} is given by \texttt{ditaa} environment automatically.
+
+\begin{ditaa}[6cm]{ditaa caption example2}{ditaaexample2}
+ +---------+
+ | cBLU |
+ | |
+ | +----+
+ | |cPNK|
+ | | |
+ +----+----+
+\end{ditaa}
+
+Enjoy!
+
+\minisec{ChangeLog:}
+%
+\begin{labeling}[\hspace{\labelsep}--]{0.9}
+\item[0.9] Preparation for first \textsf{ditaa} release.
+\end{labeling}
+
+\end{document}