summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/lualatex/cstypo/cstypo.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2016-08-30 22:09:13 +0000
committerKarl Berry <karl@freefriends.org>2016-08-30 22:09:13 +0000
commit5d57911ad9007b3033d3a7026a4c80eb84544c8a (patch)
tree5583a028dfbecb644a3b444f16748b8787e55d85 /Master/texmf-dist/doc/lualatex/cstypo/cstypo.tex
parentcbed1c425c3661149b661eb627dd7e57f0182b0f (diff)
cstypo (30aug16)
git-svn-id: svn://tug.org/texlive/trunk@41957 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/lualatex/cstypo/cstypo.tex')
-rw-r--r--Master/texmf-dist/doc/lualatex/cstypo/cstypo.tex114
1 files changed, 114 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/lualatex/cstypo/cstypo.tex b/Master/texmf-dist/doc/lualatex/cstypo/cstypo.tex
new file mode 100644
index 00000000000..9e87d617b90
--- /dev/null
+++ b/Master/texmf-dist/doc/lualatex/cstypo/cstypo.tex
@@ -0,0 +1,114 @@
+\documentclass[paper=B5,DIV=calc,parskip=half]{scrartcl}
+\usepackage{ifluatex}
+
+\usepackage{fontspec}
+%\defaultfontfeatures{Ligatures={TeX,Common},Scale=MatchLowercase}
+\setmainfont[]{Charis SIL}
+\setsansfont[Ligatures={TeX,Common}, Scale=MatchLowercase]{TeX Gyre Heros}
+\setmonofont[Ligatures=,Scale=MatchLowercase]{DejaVu Sans Mono}
+
+\usepackage{listings}
+\usepackage{enumitem}
+%\usepackage{enumitem-zref}
+\usepackage{polyglossia}
+\setmainlanguage[]{english}
+
+\author{Václav Haisman\texorpdfstring{%
+ \\{\small\href{mailto:vhaisman+cstypo@gmail.com?subject=[cstypo]}{vhaisman@gmail.com}}}{}}
+\date{\today}
+\title{\texttt{cstypo} user manual}
+
+\PassOptionsToPackage{unicode}{hyperref}
+\usepackage{bookmark}
+\usepackage{xcolor}
+\hypersetup{
+ colorlinks,
+ linkcolor={red!50!black},
+ citecolor={blue!50!black},
+ urlcolor={blue!80!black},
+ breaklinks=true}
+\urlstyle{same} % don't use monospace font for urls
+
+\usepackage{microtype}
+\usepackage{metalogo}
+
+\setlength{\emergencystretch}{3em} % prevent overfull lines
+
+\lstdefinestyle{myLatexStyle}{
+ language=[LaTeX]{Tex},
+ basicstyle=\ttfamily
+}
+
+
+\begin{document}
+\begin{titlepage}
+ \maketitle
+\end{titlepage}
+
+\tableofcontents
+
+\section{Introduction}
+The \href{https://www.ctan.org/pkg/cstypo}{\texttt{cstypo}}\footnote{Source
+ code is on GitHub in
+ \href{https://github.com/wilx/cstypo}{\texttt{wilx/cstypo}} repository.}
+package provides macros that enforce basic Czech typography rules through Lua
+hooks available in \LuaTeX{}.
+
+\begin{enumerate}%[name=rulesList]
+\item\label{itm:singleletter} There should be no line break between single
+ letter preprosition and single letter conjugations and word following them.
+\item\label{itm:percents} There should be no line break between number and \%
+ symbol.
+\end{enumerate}
+
+There are obviously more rules than these two but only the above rules are
+enforcable through this package.
+
+\section{User interface}
+
+The following two macros allow to enable and disable hook that enforces
+penalization of line breaks after single letter words:
+%(\refitem{rulesList{itm:singleletter}):
+
+\begin{lstlisting}[style=myLatexStyle]
+\cstypoSingleLetterEnable
+\cstypoSingleLetterDisable
+\end{lstlisting}
+
+The following two macros allow to enable and disable hook that enforces the
+same rule as above but for ‘a’ conjugation. The reason that this is separete
+from the rest of the single letter prepositions and conjugations is that line
+break after ‘a’ is tolerated for narrow column texts. It might be desirable
+to have this rule enforced for all of the single letter words except for the
+‘a’.
+
+\begin{lstlisting}[style=myLatexStyle]
+\cstypoALetterEnable
+\cstypoALetterDisable
+\end{lstlisting}
+
+The following two macros allow to enable and disable hook that enforces
+penalization of line breaks between number and \% symbol.
+
+\begin{lstlisting}[style=myLatexStyle]
+\cstypoPercentsEnable
+\cstypoPercentsDisable
+\end{lstlisting}
+
+\section{History}
+
+This package was inspired by
+\texttt{\href{http://www.ctan.org/pkg/impnattypo}{impnattypo}} French
+typography package. It would not be possible without help and comments from
+people of
+\href{http://chat.stackexchange.com/rooms/41/tex-latex-and-friends}{\TeX{},
+ \LaTeX{} and Friends} StackExchange chat room and the
+\href{http://tex.stackexchange.com/}{\TeX.SE} site itself.
+
+\begin{description}[style=nextline, labelwidth=4.5em, leftmargin=!, labelindent=0em]
+\item[\texttt{v0.02}] Fixed some packaging and documentation issues found by
+ CTAN submission review.
+\item[\texttt{v0.01}] First published version of this package.
+\end{description}
+
+\end{document}